Skip to content

Commit 42b1b1d

Browse files
committed
Document log4j-api changes in version 2.23.0
1 parent b3391ef commit 42b1b1d

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

log4j-api/src/main/java/org/apache/logging/log4j/status/StatusConsoleListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ public void log(final StatusData data) {
142142
* Adds package name filters to exclude.
143143
*
144144
* @param filters An array of package names to exclude.
145-
* @deprecated This method is ineffective and only kept for binary backward compatibility.
145+
* @deprecated since 2.23.0, this method is ineffective and only kept for binary backward compatibility.
146146
*/
147147
@Deprecated
148148
public void setFilters(final String... filters) {}

log4j-api/src/main/java/org/apache/logging/log4j/status/StatusData.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ public StatusData(
9494
* Returns the instant of the event.
9595
*
9696
* @return the event's instant
97+
* @since 2.23.0
9798
*/
9899
public Instant getInstant() {
99100
return instant;
@@ -103,7 +104,7 @@ public Instant getInstant() {
103104
* Returns the instant of the event.
104105
*
105106
* @return the event's instant
106-
* @deprecated Use {@link #getInstant()} instead.
107+
* @deprecated since 2.23.0, use {@link #getInstant()} instead.
107108
*/
108109
@Deprecated
109110
public long getTimestamp() {

log4j-api/src/main/java/org/apache/logging/log4j/status/StatusLogger.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -581,6 +581,7 @@ public static void setLogger(final StatusLogger logger) {
581581
* Returns the fallback listener.
582582
*
583583
* @return the fallback listener
584+
* @since 2.23.0
584585
*/
585586
public StatusConsoleListener getFallbackListener() {
586587
return fallbackListener;
@@ -590,7 +591,8 @@ public StatusConsoleListener getFallbackListener() {
590591
* Sets the level of the fallback listener.
591592
*
592593
* @param level a level
593-
* @deprecated Instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method on the fallback listener returned by {@link #getFallbackListener()}.
594+
* @deprecated Since 2.23.0, instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method
595+
* on the fallback listener returned by {@link #getFallbackListener()}.
594596
*/
595597
@Deprecated
596598
public void setLevel(final Level level) {
@@ -634,7 +636,8 @@ public void removeListener(final StatusListener listener) {
634636
*
635637
* @param level a level
636638
* @since 2.6
637-
* @deprecated Instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method on the fallback listener returned by {@link #getFallbackListener()}.
639+
* @deprecated Since 2.23.0, instead use the {@link StatusConsoleListener#setLevel(Level) setLevel(Level)} method
640+
* on the fallback listener returned by {@link #getFallbackListener()}.
638641
*/
639642
@Deprecated
640643
public void updateListenerLevel(final Level level) {
@@ -690,7 +693,8 @@ private static void closeListenerSafely(final StatusListener listener) {
690693
/**
691694
* Returns buffered events.
692695
*
693-
* @deprecated Instead of relying on the buffering provided by {@code StatusLogger}, users should register their own listeners to access to logged events.
696+
* @deprecated Since 2.23.0, instead of relying on the buffering provided by {@code StatusLogger},
697+
* users should register their own listeners to access to logged events.
694698
* @return a thread-safe read-only collection of buffered events
695699
*/
696700
@Deprecated
@@ -704,7 +708,8 @@ public List<StatusData> getStatusData() {
704708
/**
705709
* Clears the event buffer.
706710
*
707-
* @deprecated Instead of relying on the buffering provided by {@code StatusLogger}, users should register their own listeners to access to logged events.
711+
* @deprecated Since 2.23.0, instead of relying on the buffering provided by {@code StatusLogger},
712+
* users should register their own listeners to access to logged events.
708713
*/
709714
@Deprecated
710715
public void clear() {

0 commit comments

Comments
 (0)