Skip to content

Commit 65ef068

Browse files
committed
Add setter for log prefix in ObjectLogger and StreamLogger. (#164)
Deprecate constructor with prefix argument.
1 parent c74d0b4 commit 65ef068

4 files changed

Lines changed: 29 additions & 7 deletions

File tree

metafacture-monitoring/src/main/java/org/metafacture/monitoring/ObjectLogger.java

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,25 +41,36 @@ public final class ObjectLogger<T>
4141

4242
private static final MetafactureLogger LOG = new MetafactureLogger(ObjectLogger.class);
4343

44-
private final String logPrefix;
44+
private String logPrefix = "";
4545

4646
/**
4747
* Creates an instance of {@link ObjectLogger}.
4848
*/
4949
public ObjectLogger() {
50-
this("");
5150
}
5251

5352
/**
5453
* Creates an instance of {@link ObjectLogger} by a given prefix of the log
5554
* messages.
5655
*
56+
* @deprecated Use {@link #setPrefix} instead.
57+
*
5758
* @param logPrefix the prefix of the log messages
5859
*/
60+
@Deprecated/*(since="9.0", forRemoval=true)*/
5961
public ObjectLogger(final String logPrefix) {
6062
this.logPrefix = logPrefix;
6163
}
6264

65+
/**
66+
* Sets the prefix used when logging messages.
67+
*
68+
* @param prefix the prefix of the log messages
69+
*/
70+
public void setPrefix(final String prefix) {
71+
this.logPrefix = prefix;
72+
}
73+
6374
@Override
6475
public void process(final T obj) {
6576
LOG.externalDebug("{}{}", logPrefix, obj);

metafacture-monitoring/src/main/java/org/metafacture/monitoring/StreamLogger.java

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,34 @@ public final class StreamLogger
4141

4242
private static final MetafactureLogger LOG = new MetafactureLogger(StreamLogger.class);
4343

44-
private final String logPrefix;
44+
private String logPrefix = "";
4545

4646
/**
4747
* Creates an instance of {@link StreamLogger}.
4848
*/
4949
public StreamLogger() {
50-
this("");
5150
}
5251

5352
/**
5453
* Creates an instance of {@link StreamLogger} by a given prefix used when log
5554
* messages.
5655
*
56+
* @deprecated Use {@link #setPrefix} instead.
57+
*
5758
* @param logPrefix the prefix of the log messages
5859
*/
60+
@Deprecated/*(since="9.0", forRemoval=true)*/
5961
public StreamLogger(final String logPrefix) {
60-
this.logPrefix = logPrefix;
62+
setPrefix(logPrefix);
63+
}
64+
65+
/**
66+
* Sets the prefix used when logging messages.
67+
*
68+
* @param prefix the prefix of the log messages
69+
*/
70+
public void setPrefix(final String prefix) {
71+
this.logPrefix = prefix;
6172
}
6273

6374
@Override

metafacture-monitoring/src/test/java/org/metafacture/monitoring/ObjectLoggerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public void shouldActAsSinkIfNoReceiverIsSet() {
9393
@Test
9494
public void shouldLogWithPrefix() {
9595
final String prefix = "prefix:";
96-
logger = new ObjectLogger<>(prefix);
96+
logger.setPrefix(prefix);
9797

9898
logger.process("object");
9999
logger.resetStream();

metafacture-monitoring/src/test/java/org/metafacture/monitoring/StreamLoggerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public void shouldActAsSinkIfNoReceiverIsSet() {
114114
@Test
115115
public void shouldLogWithPrefix() {
116116
final String prefix = "prefix:";
117-
logger = new StreamLogger(prefix);
117+
logger.setPrefix(prefix);
118118

119119
logger.startRecord("1");
120120
logger.startEntity("entity");

0 commit comments

Comments
 (0)