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 7f6920aa25094ee565bd90ed164d110b51df0560 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sun Dec 29 07:37:29 2024 +0100 Document `log4j-api` changes in version 2.11.0 --- .../logging/log4j/util/internal/DefaultObjectInputFilter.java | 3 +++ .../java/org/apache/logging/log4j/message/ParameterConsumer.java | 2 +- .../org/apache/logging/log4j/message/ParameterVisitable.java | 2 +- .../main/java/org/apache/logging/log4j/spi/AbstractLogger.java | 9 +++++++++ .../org/apache/logging/log4j/spi/ThreadContextMapFactory.java | 2 ++ log4j-api/src/main/java/org/apache/logging/log4j/util/Chars.java | 5 ++++- .../org/apache/logging/log4j/util/FilteredObjectInputStream.java | 2 +- 7 files changed, 21 insertions(+), 4 deletions(-) diff --git a/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/internal/DefaultObjectInputFilter.java b/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/internal/DefaultObjectInputFilter.java index df62f71e5f..75491b3911 100644 --- a/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/internal/DefaultObjectInputFilter.java +++ b/log4j-api-java9/src/main/java/org/apache/logging/log4j/util/internal/DefaultObjectInputFilter.java @@ -21,6 +21,9 @@ import static org.apache.logging.log4j.util.internal.SerializationUtil.REQUIRED_ import java.io.ObjectInputFilter; +/** + * @since 2.11.0 + */ public class DefaultObjectInputFilter implements ObjectInputFilter { private final ObjectInputFilter delegate; diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java index 199d0b4f6a..7bbd8120d3 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterConsumer.java @@ -26,7 +26,7 @@ package org.apache.logging.log4j.message; * * @param <S> state data * @see ReusableMessage - * @since 2.11 + * @since 2.11.0 */ public interface ParameterConsumer<S> { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterVisitable.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterVisitable.java index f0ce3e820f..b9dfb918ef 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterVisitable.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterVisitable.java @@ -22,7 +22,7 @@ import org.apache.logging.log4j.util.PerformanceSensitive; * Allows message parameters to be iterated over without any allocation * or memory copies. * - * @since 2.11 + * @since 2.11.0 */ @PerformanceSensitive("allocation") public interface ParameterVisitable { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java index 3126ce4f6e..3d965dd91f 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java @@ -678,6 +678,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog return flowMessage; } + /** + * @deprecated since 2.11.0 + */ @Deprecated @Override public void entry() { @@ -1088,12 +1091,18 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logIfEnabled(FQCN, Level.ERROR, null, message, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9); } + /** + * @deprecated since 2.11.0 + */ @Deprecated @Override public void exit() { exit(FQCN, (Object) null); } + /** + * @deprecated since 2.11.0 + */ @Deprecated @Override public <R> R exit(final R result) { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMapFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMapFactory.java index 418beb4583..bf97c1aebb 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMapFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ThreadContextMapFactory.java @@ -46,6 +46,8 @@ public final class ThreadContextMapFactory { /** * Initializes static variables based on system properties. Normally called when this class is initialized by the VM * and when Log4j is reconfigured. + * + * @since 2.11.0 */ public static void init() { ProviderUtil.getProvider().getThreadContextMapInstance(); diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/Chars.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/Chars.java index e76b7eff37..509f15811f 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/Chars.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/Chars.java @@ -35,7 +35,10 @@ public final class Chars { /** Line Feed. */ public static final char LF = '\n'; - /** NUL. */ + /** + * NUL. + * @since 2.11.0 + */ public static final char NUL = 0; /** Single Quote [']. */ diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/FilteredObjectInputStream.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/FilteredObjectInputStream.java index 52b71507de..d207e41949 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/FilteredObjectInputStream.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/FilteredObjectInputStream.java @@ -32,7 +32,7 @@ import org.apache.logging.log4j.util.internal.SerializationUtil; * Extends {@link ObjectInputStream} to only allow some built-in Log4j classes and caller-specified classes to be * deserialized. * - * @since 2.8.2 + * @since 2.11.0 */ public class FilteredObjectInputStream extends ObjectInputStream {
