Skip to content

Commit 47c7cc7

Browse files
committed
clarify Logger.makeLoggingEventBuilder javadoc
Signed-off-by: Ceki Gulcu <ceki@qos.ch>
1 parent 0be1bc1 commit 47c7cc7

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

slf4j-api/src/main/java/org/slf4j/Logger.java

+9-7
Original file line numberDiff line numberDiff line change
@@ -99,16 +99,18 @@ public interface Logger {
9999
/**
100100
* <p>Make a new {@link LoggingEventBuilder} instance as appropriate for this logger implementation.
101101
* This default implementation always returns a new instance of {@link DefaultLoggingEventBuilder}.</p>
102-
*
103-
* <p>Note that the {@link LoggingEventBuilder} should be built for all levels, independently of the level.
104-
* In other words, this method is an <b>unconditional</b> constructor for the {@link LoggingEventBuilder}
105-
* appropriate for this logger implementation.</p>
106-
*
102+
* <p></p>
103+
* <p>This method is intended to be used by logging systems implementing the SLF4J API and <b>not</b>
104+
* by end users.</p>
105+
* <p></p>
106+
* <p>Also note that a {@link LoggingEventBuilder} instance should be built for all levels,
107+
* independently of the level argument. In other words, this method is an <b>unconditional</b>
108+
* constructor for the {@link LoggingEventBuilder} appropriate for this logger implementation.</p>
109+
* <p></p>
107110
* @param level desired level for the event builder
108-
* @return a new {@link LoggingEventBuilder} instance as appropriate for this logger
111+
* @return a new {@link LoggingEventBuilder} instance as appropriate for <b>this</b> logger
109112
* @since 2.0
110113
*/
111-
@CheckReturnValue
112114
default public LoggingEventBuilder makeLoggingEventBuilder(Level level) {
113115
return new DefaultLoggingEventBuilder(this, level);
114116
}

0 commit comments

Comments
 (0)