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 17389ccfadd4edcd7106bb65cff350d046dd0bc6 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sun Dec 29 10:43:17 2024 +0100 Document `log4j-api` changes in version 2.24.0 --- .../java/org/apache/logging/log4j/EventLogger.java | 3 +- .../log4j/message/DefaultFlowMessageFactory.java | 3 ++ .../message/ReusableParameterizedMessage.java | 33 ++++++++++++++++++++++ .../apache/logging/log4j/spi/AbstractLogger.java | 1 + .../org/apache/logging/log4j/spi/Provider.java | 3 +- 5 files changed, 41 insertions(+), 2 deletions(-) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/EventLogger.java b/log4j-api/src/main/java/org/apache/logging/log4j/EventLogger.java index 9b08fa2d85..f88dccce89 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/EventLogger.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/EventLogger.java @@ -22,7 +22,8 @@ import org.apache.logging.log4j.spi.ExtendedLogger; /** * Convenience to log {@link StructuredDataMessage}s. * - * @deprecated {@link Logger} accepts {@link StructuredDataMessage}s, users should use to that instead. + * @deprecated Deprecated since 2.24.0. + * {@link Logger} accepts {@link StructuredDataMessage}s, users should use to that instead. */ @Deprecated public final class EventLogger { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/DefaultFlowMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/DefaultFlowMessageFactory.java index 57dbd29b8a..7b93274578 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/DefaultFlowMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/DefaultFlowMessageFactory.java @@ -32,6 +32,9 @@ public class DefaultFlowMessageFactory implements FlowMessageFactory, Serializab private static final String ENTRY_DEFAULT_PREFIX = "Enter"; private static final long serialVersionUID = 8578655591131397576L; + /** + * @since 2.24.0 + */ public static final FlowMessageFactory INSTANCE = new DefaultFlowMessageFactory(); private final String entryText; diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableParameterizedMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableParameterizedMessage.java index f9690ee4bf..d3734eeedd 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableParameterizedMessage.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableParameterizedMessage.java @@ -135,18 +135,27 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return null; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set(final String messagePattern, final Object... arguments) { init(messagePattern, arguments == null ? 0 : arguments.length, arguments); varargs = arguments; return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set(final String messagePattern, final Object p0) { params[0] = p0; init(messagePattern, 1, params); return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set(final String messagePattern, final Object p0, final Object p1) { params[0] = p0; params[1] = p1; @@ -154,6 +163,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, final Object p1, final Object p2) { params[0] = p0; @@ -163,6 +175,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, final Object p1, final Object p2, final Object p3) { params[0] = p0; @@ -173,6 +188,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, @@ -189,6 +207,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, @@ -207,6 +228,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, @@ -227,6 +251,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, @@ -249,6 +276,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, @@ -273,6 +303,9 @@ public class ReusableParameterizedMessage implements ReusableMessage, ParameterV return this; } + /** + * @since 2.24.0 + */ public ReusableParameterizedMessage set( final String messagePattern, final Object p0, 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 4ed9e6f8a6..f5285a1e94 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 @@ -138,6 +138,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog * @param name the logger name (if null, will be derived from this class) * @param messageFactory the {@link Message} factory (if null, {@link ParameterizedMessageFactory} will be used) * @param flowMessageFactory the {@link org.apache.logging.log4j.message.FlowMessage} factory (if null, {@link DefaultFlowMessageFactory} will be used) + * @since 2.24.0 */ protected AbstractLogger( final String name, final MessageFactory messageFactory, final FlowMessageFactory flowMessageFactory) { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/Provider.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/Provider.java index c7718dc43e..4b9ab3f8d5 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/Provider.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/Provider.java @@ -43,6 +43,7 @@ import org.jspecify.annotations.Nullable; public class Provider { /** * Constant inlined by the compiler + * @since 2.24.0 */ protected static final String CURRENT_VERSION = "2.6.0"; @@ -317,7 +318,7 @@ public class Provider { * * @return the URL corresponding to the Provider {@code META-INF/log4j-provider.properties} file or {@code null} * for a provider class. - * @deprecated since 2.24.0, without replacement. + * @deprecated since 2.24.0, without a replacement. */ @Deprecated public @Nullable URL getUrl() {
