This is an automated email from the ASF dual-hosted git repository. pkarwasz pushed a commit to branch doc/2.x/since-tag in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 42b1b1d3a0ea08d76d4bbf164938d6224def1e31 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sun Dec 29 10:31:38 2024 +0100 Document `log4j-api` changes in version 2.23.0 --- .../apache/logging/log4j/status/StatusConsoleListener.java | 2 +- .../java/org/apache/logging/log4j/status/StatusData.java | 3 ++- .../java/org/apache/logging/log4j/status/StatusLogger.java | 13 +++++++++---- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java index 6261c172aa..ce23ff5aa9 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java @@ -142,7 +142,7 @@ public class StatusConsoleListener implements StatusListener { * Adds package name filters to exclude. * * @param filters An array of package names to exclude. - * @deprecated This method is ineffective and only kept for binary backward compatibility. + * @deprecated since 2.23.0, this method is ineffective and only kept for binary backward compatibility. */ @Deprecated public void setFilters(final String... filters) {} diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusData.java b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusData.java index b7146ae605..55f13201e7 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusData.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusData.java @@ -94,6 +94,7 @@ public class StatusData implements Serializable { * Returns the instant of the event. * * @return the event's instant + * @since 2.23.0 */ public Instant getInstant() { return instant; @@ -103,7 +104,7 @@ public class StatusData implements Serializable { * Returns the instant of the event. * * @return the event's instant - * @deprecated Use {@link #getInstant()} instead. + * @deprecated since 2.23.0, use {@link #getInstant()} instead. */ @Deprecated public long getTimestamp() { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java index 87e638096b..6aec303cba 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java @@ -581,6 +581,7 @@ public class StatusLogger extends AbstractLogger { * Returns the fallback listener. * * @return the fallback listener + * @since 2.23.0 */ public StatusConsoleListener getFallbackListener() { return fallbackListener; @@ -590,7 +591,8 @@ public class StatusLogger extends AbstractLogger { * Sets the level of the fallback listener. * * @param level a level - * @deprecated Instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method on the fallback listener returned by {@link #getFallbackListener()}. + * @deprecated Since 2.23.0, instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method + * on the fallback listener returned by {@link #getFallbackListener()}. */ @Deprecated public void setLevel(final Level level) { @@ -634,7 +636,8 @@ public class StatusLogger extends AbstractLogger { * * @param level a level * @since 2.6 - * @deprecated Instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method on the fallback listener returned by {@link #getFallbackListener()}. + * @deprecated Since 2.23.0, instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method + * on the fallback listener returned by {@link #getFallbackListener()}. */ @Deprecated public void updateListenerLevel(final Level level) { @@ -690,7 +693,8 @@ public class StatusLogger extends AbstractLogger { /** * Returns buffered events. * - * @deprecated Instead of relying on the buffering provided by {@code StatusLogger}, users should register their own listeners to access to logged events. + * @deprecated Since 2.23.0, instead of relying on the buffering provided by {@code StatusLogger}, + * users should register their own listeners to access to logged events. * @return a thread-safe read-only collection of buffered events */ @Deprecated @@ -704,7 +708,8 @@ public class StatusLogger extends AbstractLogger { /** * Clears the event buffer. * - * @deprecated Instead of relying on the buffering provided by {@code StatusLogger}, users should register their own listeners to access to logged events. + * @deprecated Since 2.23.0, instead of relying on the buffering provided by {@code StatusLogger}, + * users should register their own listeners to access to logged events. */ @Deprecated public void clear() {
