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 05ea3e746d68c18d7bad0059eb34f84e32df6e29 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sat Dec 28 17:26:27 2024 +0100 Document `log4j-api` changes in version 2.4 --- .../java/org/apache/logging/log4j/spi/AbstractLogger.java | 11 +++++++++-- .../java/org/apache/logging/log4j/spi/ExtendedLogger.java | 3 +++ .../main/java/org/apache/logging/log4j/status/StatusData.java | 2 ++ .../main/java/org/apache/logging/log4j/util/LambdaUtil.java | 1 + .../java/org/apache/logging/log4j/util/PropertiesUtil.java | 1 + 5 files changed, 16 insertions(+), 2 deletions(-) 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 06d99f3f15..4bfc04bdb1 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 @@ -2588,6 +2588,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, messageFactory.newMessage(message), throwable); } + /** + * @since 2.4 + */ protected void logMessage( final String fqcn, final Level level, @@ -2600,7 +2603,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, message, effectiveThrowable); } - @SuppressWarnings("deprecation") + /** + * @since 2.4 + */ protected void logMessage( final String fqcn, final Level level, @@ -2774,7 +2779,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } - @SuppressWarnings("deprecation") + /** + * @since 2.4 + */ protected void logMessage( final String fqcn, final Level level, diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ExtendedLogger.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ExtendedLogger.java index 29b02cf53d..eba21ac23a 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/ExtendedLogger.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/ExtendedLogger.java @@ -633,6 +633,7 @@ public interface ExtendedLogger extends Logger { * @param marker A Marker or null. * @param msgSupplier A function, which when called, produces the desired log message. * @param t the exception to log, including its stack trace. + * @since 2.4 */ void logIfEnabled(String fqcn, Level level, Marker marker, MessageSupplier msgSupplier, Throwable t); @@ -645,6 +646,7 @@ public interface ExtendedLogger extends Logger { * @param marker A Marker or null. * @param message The message format. * @param paramSuppliers An array of functions, which when called, produce the desired log message parameters. + * @since 2.4 */ @SuppressWarnings("deprecation") void logIfEnabled(String fqcn, Level level, Marker marker, String message, Supplier<?>... paramSuppliers); @@ -658,6 +660,7 @@ public interface ExtendedLogger extends Logger { * @param marker A Marker or null. * @param msgSupplier A function, which when called, produces the desired log message. * @param t the exception to log, including its stack trace. + * @since 2.4 */ @SuppressWarnings("deprecation") void logIfEnabled(String fqcn, Level level, Marker marker, Supplier<?> msgSupplier, Throwable t); 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 b100ade3ed..b7146ae605 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 @@ -60,6 +60,7 @@ public class StatusData implements Serializable { * @param message a message * @param throwable the error occurred * @param threadName the thread name + * @since 2.4 */ public StatusData( @Nullable final StackTraceElement caller, @@ -141,6 +142,7 @@ public class StatusData implements Serializable { * Returns the name of the thread associated with the event. * * @return the name of the thread associated with the event + * @since 2.4 */ public String getThreadName() { return threadName; diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/LambdaUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/LambdaUtil.java index ef1f3b0b32..2fac29a019 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/LambdaUtil.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/LambdaUtil.java @@ -21,6 +21,7 @@ import org.apache.logging.log4j.message.MessageFactory; /** * Utility class for lambda support. + * @since 2.4 */ public final class LambdaUtil { /** diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java index 30b92854b0..f36dcbea8f 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java @@ -596,6 +596,7 @@ public final class PropertiesUtil { * @param properties The Properties to evaluate. * @param prefix The prefix to extract. * @return The subset of properties. + * @since 2.4 */ public static Properties extractSubset(final Properties properties, final String prefix) { final Properties subset = new Properties();
