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 8742914d9e73cc86224e084a4b4af19597da45a6 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sat Dec 28 18:32:03 2024 +0100 Document `log4j-api` changes in version 2.6 --- .../logging/log4j/CloseableThreadContext.java | 3 + .../main/java/org/apache/logging/log4j/Logger.java | 150 ++++++++++++++++++++- .../log4j/message/ParameterizedMessage.java | 2 +- .../log4j/message/ReusableMessageFactory.java | 2 +- .../apache/logging/log4j/spi/AbstractLogger.java | 52 ++++++- .../apache/logging/log4j/spi/ExtendedLogger.java | 22 +++ .../apache/logging/log4j/spi/LoggerRegistry.java | 4 + .../apache/logging/log4j/status/StatusLogger.java | 1 + .../org/apache/logging/log4j/util/LambdaUtil.java | 1 + .../apache/logging/log4j/util/PropertiesUtil.java | 1 + .../org/apache/logging/log4j/util/Strings.java | 1 + 11 files changed, 233 insertions(+), 6 deletions(-) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/CloseableThreadContext.java b/log4j-api/src/main/java/org/apache/logging/log4j/CloseableThreadContext.java index c585edf546..f66c8144ba 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/CloseableThreadContext.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/CloseableThreadContext.java @@ -99,6 +99,9 @@ public class CloseableThreadContext { return new CloseableThreadContext.Instance().putAll(values); } + /** + * @since 2.6 + */ public static class Instance implements AutoCloseable { private int pushCount = 0; diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java b/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java index ef461ddfe3..268b9e699e 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/Logger.java @@ -142,6 +142,7 @@ public interface Logger { * * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. + * @since 2.6 */ void debug(Marker marker, CharSequence message); @@ -152,6 +153,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void debug(Marker marker, CharSequence message, Throwable throwable); @@ -274,6 +276,7 @@ public interface Logger { * Logs a message CharSequence with the {@link Level#DEBUG DEBUG} level. * * @param message the message object to log. + * @since 2.6 */ void debug(CharSequence message); @@ -283,6 +286,7 @@ public interface Logger { * * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void debug(CharSequence message, Throwable throwable); @@ -363,6 +367,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void debug(Marker marker, String message, Object p0); @@ -373,6 +378,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void debug(Marker marker, String message, Object p0, Object p1); @@ -384,6 +390,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void debug(Marker marker, String message, Object p0, Object p1, Object p2); @@ -396,6 +403,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void debug(Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -409,6 +417,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void debug(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -423,6 +432,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void debug(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -438,6 +448,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void debug( Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -455,6 +466,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void debug( Marker marker, @@ -482,6 +494,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void debug( Marker marker, @@ -511,6 +524,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void debug( Marker marker, @@ -531,6 +545,7 @@ public interface Logger { * * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0); @@ -540,6 +555,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1); @@ -550,6 +566,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1, Object p2); @@ -561,6 +578,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1, Object p2, Object p3); @@ -573,6 +591,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -586,6 +605,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -600,6 +620,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -615,6 +636,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void debug(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7); @@ -631,6 +653,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void debug( String message, @@ -658,6 +681,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void debug( String message, @@ -675,7 +699,7 @@ public interface Logger { /** * Logs entry to a method. Used when the method in question has no parameters or when the parameters should not be * logged. - * @deprecated Use {@link #traceEntry()} instead which performs the same function. + * @deprecated :uUse {@link #traceEntry()} instead which performs the same function. */ @Deprecated void entry(); @@ -747,6 +771,7 @@ public interface Logger { * * @param marker the marker data specific to this log statement. * @param message the message CharSequence to log. + * @since 2.6 */ void error(Marker marker, CharSequence message); @@ -757,6 +782,7 @@ public interface Logger { * @param marker the marker data specific to this log statement. * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void error(Marker marker, CharSequence message, Throwable throwable); @@ -879,6 +905,7 @@ public interface Logger { * Logs a message CharSequence with the {@link Level#ERROR ERROR} level. * * @param message the message CharSequence to log. + * @since 2.6 */ void error(CharSequence message); @@ -888,6 +915,7 @@ public interface Logger { * * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void error(CharSequence message, Throwable throwable); @@ -968,6 +996,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void error(Marker marker, String message, Object p0); @@ -978,6 +1007,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void error(Marker marker, String message, Object p0, Object p1); @@ -989,6 +1019,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void error(Marker marker, String message, Object p0, Object p1, Object p2); @@ -1001,6 +1032,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void error(Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -1014,6 +1046,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void error(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -1028,6 +1061,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void error(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -1043,6 +1077,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void error( Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -1060,6 +1095,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void error( Marker marker, @@ -1087,6 +1123,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void error( Marker marker, @@ -1116,6 +1153,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void error( Marker marker, @@ -1136,6 +1174,7 @@ public interface Logger { * * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void error(String message, Object p0); @@ -1145,6 +1184,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1); @@ -1155,6 +1195,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1, Object p2); @@ -1166,6 +1207,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1, Object p2, Object p3); @@ -1178,6 +1220,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -1191,6 +1234,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -1205,6 +1249,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -1220,6 +1265,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void error(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7); @@ -1236,6 +1282,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void error( String message, @@ -1263,6 +1310,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void error( String message, @@ -1279,7 +1327,7 @@ public interface Logger { /** * Logs exit from a method. Used for methods that do not return anything. - * @deprecated Use {@link #traceExit()} instead which performs the same function. + * @deprecated Since 2.6, use {@link #traceExit()} instead which performs the same function. */ @Deprecated void exit(); @@ -1294,7 +1342,7 @@ public interface Logger { * @param <R> The type of the parameter and object being returned. * @param result The result being returned from the method call. * @return the result. - * @deprecated Use {@link #traceExit(Object)} instead which performs the same function. + * @deprecated Since 2.6, use {@link #traceExit(Object)} instead which performs the same function. */ @Deprecated <R> R exit(R result); @@ -1344,6 +1392,7 @@ public interface Logger { * * @param marker The marker data specific to this log statement. * @param message the message CharSequence to log. + * @since 2.6 */ void fatal(Marker marker, CharSequence message); @@ -1354,6 +1403,7 @@ public interface Logger { * @param marker The marker data specific to this log statement. * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void fatal(Marker marker, CharSequence message, Throwable throwable); @@ -1476,6 +1526,7 @@ public interface Logger { * Logs a message CharSequence with the {@link Level#FATAL FATAL} level. * * @param message the message CharSequence to log. + * @since 2.6 */ void fatal(CharSequence message); @@ -1485,6 +1536,7 @@ public interface Logger { * * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void fatal(CharSequence message, Throwable throwable); @@ -1565,6 +1617,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void fatal(Marker marker, String message, Object p0); @@ -1575,6 +1628,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void fatal(Marker marker, String message, Object p0, Object p1); @@ -1586,6 +1640,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void fatal(Marker marker, String message, Object p0, Object p1, Object p2); @@ -1598,6 +1653,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void fatal(Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -1611,6 +1667,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void fatal(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -1625,6 +1682,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void fatal(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -1640,6 +1698,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void fatal( Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -1657,6 +1716,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void fatal( Marker marker, @@ -1684,6 +1744,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void fatal( Marker marker, @@ -1713,6 +1774,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void fatal( Marker marker, @@ -1733,6 +1795,7 @@ public interface Logger { * * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0); @@ -1742,6 +1805,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1); @@ -1752,6 +1816,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1, Object p2); @@ -1763,6 +1828,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1, Object p2, Object p3); @@ -1775,6 +1841,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -1788,6 +1855,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -1802,6 +1870,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -1817,6 +1886,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void fatal(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7); @@ -1833,6 +1903,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void fatal( String message, @@ -1860,6 +1931,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void fatal( String message, @@ -1955,6 +2027,7 @@ public interface Logger { * * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. + * @since 2.6 */ void info(Marker marker, CharSequence message); @@ -1965,6 +2038,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void info(Marker marker, CharSequence message, Throwable throwable); @@ -2176,6 +2250,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void info(Marker marker, String message, Object p0); @@ -2186,6 +2261,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void info(Marker marker, String message, Object p0, Object p1); @@ -2197,6 +2273,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void info(Marker marker, String message, Object p0, Object p1, Object p2); @@ -2209,6 +2286,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void info(Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -2222,6 +2300,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void info(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -2236,6 +2315,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void info(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -2251,6 +2331,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void info( Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -2268,6 +2349,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void info( Marker marker, @@ -2295,6 +2377,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void info( Marker marker, @@ -2324,6 +2407,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void info( Marker marker, @@ -2344,6 +2428,7 @@ public interface Logger { * * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void info(String message, Object p0); @@ -2353,6 +2438,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1); @@ -2363,6 +2449,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1, Object p2); @@ -2374,6 +2461,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1, Object p2, Object p3); @@ -2386,6 +2474,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -2399,6 +2488,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -2413,6 +2503,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -2428,6 +2519,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void info(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7); @@ -2444,6 +2536,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void info( String message, @@ -2471,6 +2564,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void info( String message, @@ -2651,6 +2745,7 @@ public interface Logger { * @param level the logging level * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. + * @since 2.6 */ void log(Level level, Marker marker, CharSequence message); @@ -2662,6 +2757,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void log(Level level, Marker marker, CharSequence message, Throwable throwable); @@ -2795,6 +2891,7 @@ public interface Logger { * * @param level the logging level * @param message the message CharSequence to log. + * @since 2.6 */ void log(Level level, CharSequence message); @@ -2805,6 +2902,7 @@ public interface Logger { * @param level the logging level * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void log(Level level, CharSequence message, Throwable throwable); @@ -2893,6 +2991,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void log(Level level, Marker marker, String message, Object p0); @@ -2904,6 +3003,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void log(Level level, Marker marker, String message, Object p0, Object p1); @@ -2916,6 +3016,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void log(Level level, Marker marker, String message, Object p0, Object p1, Object p2); @@ -2929,6 +3030,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void log(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -2943,6 +3045,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void log(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -2958,6 +3061,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -2983,6 +3087,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3010,6 +3115,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3039,6 +3145,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3070,6 +3177,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3092,6 +3200,7 @@ public interface Logger { * @param level the logging level * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0); @@ -3102,6 +3211,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0, Object p1); @@ -3113,6 +3223,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0, Object p1, Object p2); @@ -3125,6 +3236,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0, Object p1, Object p2, Object p3); @@ -3138,6 +3250,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -3152,6 +3265,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -3167,6 +3281,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void log(Level level, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -3183,6 +3298,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3210,6 +3326,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3239,6 +3356,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void log( Level level, @@ -3346,6 +3464,7 @@ public interface Logger { * * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. + * @since 2.6 */ void trace(Marker marker, CharSequence message); @@ -3357,6 +3476,7 @@ public interface Logger { * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. * @see #debug(String) + * @since 2.6 */ void trace(Marker marker, CharSequence message, Throwable throwable); @@ -3573,6 +3693,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void trace(Marker marker, String message, Object p0); @@ -3583,6 +3704,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void trace(Marker marker, String message, Object p0, Object p1); @@ -3594,6 +3716,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void trace(Marker marker, String message, Object p0, Object p1, Object p2); @@ -3606,6 +3729,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void trace(Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -3619,6 +3743,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void trace(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -3633,6 +3758,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void trace(Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -3648,6 +3774,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void trace( Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -3665,6 +3792,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void trace( Marker marker, @@ -3692,6 +3820,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void trace( Marker marker, @@ -3721,6 +3850,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void trace( Marker marker, @@ -3741,6 +3871,7 @@ public interface Logger { * * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0); @@ -3750,6 +3881,7 @@ public interface Logger { * @param message the message to log; the format depends on the message factory. * @param p0 parameter to the message. * @param p1 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1); @@ -3760,6 +3892,7 @@ public interface Logger { * @param p0 parameter to the message. * @param p1 parameter to the message. * @param p2 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1, Object p2); @@ -3771,6 +3904,7 @@ public interface Logger { * @param p1 parameter to the message. * @param p2 parameter to the message. * @param p3 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1, Object p2, Object p3); @@ -3783,6 +3917,7 @@ public interface Logger { * @param p2 parameter to the message. * @param p3 parameter to the message. * @param p4 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -3796,6 +3931,7 @@ public interface Logger { * @param p3 parameter to the message. * @param p4 parameter to the message. * @param p5 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5); @@ -3810,6 +3946,7 @@ public interface Logger { * @param p4 parameter to the message. * @param p5 parameter to the message. * @param p6 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6); @@ -3825,6 +3962,7 @@ public interface Logger { * @param p5 parameter to the message. * @param p6 parameter to the message. * @param p7 parameter to the message. + * @since 2.6 */ void trace(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7); @@ -3841,6 +3979,7 @@ public interface Logger { * @param p6 parameter to the message. * @param p7 parameter to the message. * @param p8 parameter to the message. + * @since 2.6 */ void trace( String message, @@ -3868,6 +4007,7 @@ public interface Logger { * @param p7 parameter to the message. * @param p8 parameter to the message. * @param p9 parameter to the message. + * @since 2.6 */ void trace( String message, @@ -4110,6 +4250,7 @@ public interface Logger { * * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. + * @since 2.6 */ void warn(Marker marker, CharSequence message); @@ -4120,6 +4261,7 @@ public interface Logger { * @param marker the marker data specific to this log statement * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void warn(Marker marker, CharSequence message, Throwable throwable); @@ -4242,6 +4384,7 @@ public interface Logger { * Logs a message CharSequence with the {@link Level#WARN WARN} level. * * @param message the message CharSequence to log. + * @since 2.6 */ void warn(CharSequence message); @@ -4251,6 +4394,7 @@ public interface Logger { * * @param message the message CharSequence to log. * @param throwable the {@code Throwable} to log, including its stack trace. + * @since 2.6 */ void warn(CharSequence message, Throwable throwable); diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java index 4da3642cca..a93b495e42 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterizedMessage.java @@ -112,7 +112,7 @@ public class ParameterizedMessage implements Message, StringBuilderFormattable { * @param pattern a formatting pattern * @param args arguments to be formatted * @param throwable a {@link Throwable} - * @deprecated Use {@link #ParameterizedMessage(String, Object[], Throwable)} instead + * @deprecated Since 2.6, use {@link #ParameterizedMessage(String, Object[], Throwable)} instead */ @InlineMe( replacement = "this(pattern, Arrays.stream(args).toArray(Object[]::new), throwable)", diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableMessageFactory.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableMessageFactory.java index 92712ac8cf..1e50475558 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableMessageFactory.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/ReusableMessageFactory.java @@ -37,7 +37,7 @@ import org.apache.logging.log4j.util.PerformanceSensitive; public final class ReusableMessageFactory implements MessageFactory2, Serializable { /** - * Instance of ReusableMessageFactory.. + * Instance of ReusableMessageFactory. */ public static final ReusableMessageFactory INSTANCE = new ReusableMessageFactory(); 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 4bfc04bdb1..f89647e522 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 @@ -89,6 +89,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog /** * The default FlowMessageFactory class. + * @since 2.6 */ public static final Class<? extends FlowMessageFactory> DEFAULT_FLOW_MESSAGE_FACTORY_CLASS = DefaultFlowMessageFactory.class; @@ -584,6 +585,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog * @param fqcn The fully qualified class name of the <b>caller</b>. * @param format Format String for the parameters. * @param paramSuppliers The Suppliers of the parameters. + * @since 2.6 */ @SuppressWarnings("deprecation") protected EntryMessage enter(final String fqcn, final String format, final Supplier<?>... paramSuppliers) { @@ -605,6 +607,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog * @param fqcn The fully qualified class name of the <b>caller</b>. * @param format The format String for the parameters. * @param paramSuppliers The parameters to the method. + * @since 2.6 */ @Deprecated protected EntryMessage enter(final String fqcn, final String format, final MessageSupplier... paramSuppliers) { @@ -621,6 +624,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog * @param fqcn The fully qualified class name of the <b>caller</b>. * @param format The format String for the parameters. * @param params The parameters to the method. + * @since 2.6 */ protected EntryMessage enter(final String fqcn, final String format, final Object... params) { EntryMessage entryMsg = null; @@ -640,6 +644,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog * * @param fqcn The fully qualified class name of the <b>caller</b>. * @param messageSupplier The Supplier of the Message. + * @since 2.6 */ @Deprecated protected EntryMessage enter(final String fqcn, final MessageSupplier messageSupplier) { @@ -702,10 +707,16 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog } } + /** + * @since 2.6 + */ protected EntryMessage entryMsg(final String format, final Object... params) { return flowMessageFactory.newEntryMessage(format, params); } + /** + * @since 2.6 + */ protected EntryMessage entryMsg(final String format, final MessageSupplier... paramSuppliers) { final int count = paramSuppliers == null ? 0 : paramSuppliers.length; final Object[] params = new Object[count]; @@ -715,7 +726,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog return entryMsg(format, params); } - @SuppressWarnings("deprecation") + /** + * @since 2.6 + */ protected EntryMessage entryMsg(final String format, final Supplier<?>... paramSuppliers) { return entryMsg(format, LambdaUtil.getAll(paramSuppliers)); } @@ -1109,6 +1122,7 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog * @param <R> The type of the parameter and object being returned. * @param result The result being returned from the method call. * @return the return value passed to this method. + * @since 2.6 */ protected <R> R exit(final String fqcn, final String format, final R result) { if (isEnabled(Level.TRACE, EXIT_MARKER, (CharSequence) null, null)) { @@ -1117,6 +1131,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog return result; } + /** + * @since 2.6 + */ protected Message exitMsg(final String format, final Object result) { return flowMessageFactory.newExitMessage(format, result); } @@ -2570,6 +2587,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog } } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2638,12 +2658,18 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, final Marker marker, final String message, final Object p0) { final Message msg = messageFactory.newMessage(message, p0); logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2655,6 +2681,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2667,6 +2696,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2680,6 +2712,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2694,6 +2729,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2709,6 +2747,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2725,6 +2766,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2742,6 +2786,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ protected void logMessage( final String fqcn, final Level level, @@ -2760,6 +2807,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog logMessageSafely(fqcn, level, marker, msg, msg.getThrowable()); } + /** + * @since 2.6 + */ 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 eba21ac23a..e344458afe 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 @@ -48,6 +48,7 @@ public interface ExtendedLogger extends Logger { * @param message The message. * @param t A Throwable. * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled(Level level, Marker marker, CharSequence message, Throwable t); @@ -102,6 +103,7 @@ public interface ExtendedLogger extends Logger { * @param message The message. * @param p0 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled(Level level, Marker marker, String message, Object p0); @@ -114,6 +116,7 @@ public interface ExtendedLogger extends Logger { * @param p0 the message parameters * @param p1 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled(Level level, Marker marker, String message, Object p0, Object p1); @@ -127,6 +130,7 @@ public interface ExtendedLogger extends Logger { * @param p1 the message parameters * @param p2 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2); @@ -141,6 +145,7 @@ public interface ExtendedLogger extends Logger { * @param p2 the message parameters * @param p3 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -156,6 +161,7 @@ public interface ExtendedLogger extends Logger { * @param p3 the message parameters * @param p4 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled( Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4); @@ -173,6 +179,7 @@ public interface ExtendedLogger extends Logger { * @param p4 the message parameters * @param p5 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled( Level level, @@ -199,6 +206,7 @@ public interface ExtendedLogger extends Logger { * @param p5 the message parameters * @param p6 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled( Level level, @@ -227,6 +235,7 @@ public interface ExtendedLogger extends Logger { * @param p6 the message parameters * @param p7 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled( Level level, @@ -257,6 +266,7 @@ public interface ExtendedLogger extends Logger { * @param p7 the message parameters * @param p8 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled( Level level, @@ -289,6 +299,7 @@ public interface ExtendedLogger extends Logger { * @param p8 the message parameters * @param p9 the message parameters * @return True if logging is enabled, false otherwise. + * @since 2.6 */ boolean isEnabled( Level level, @@ -326,6 +337,7 @@ public interface ExtendedLogger extends Logger { * @param marker A Marker or null. * @param message The CharSequence message. * @param t the exception to log, including its stack trace. + * @since 2.6 */ void logIfEnabled(String fqcn, Level level, Marker marker, CharSequence message, Throwable t); @@ -385,6 +397,7 @@ public interface ExtendedLogger extends Logger { * @param marker A Marker or null. * @param message The message format. * @param p0 the message parameters + * @since 2.6 */ void logIfEnabled(String fqcn, Level level, Marker marker, String message, Object p0); @@ -398,6 +411,7 @@ public interface ExtendedLogger extends Logger { * @param message The message format. * @param p0 the message parameters * @param p1 the message parameters + * @since 2.6 */ void logIfEnabled(String fqcn, Level level, Marker marker, String message, Object p0, Object p1); @@ -412,6 +426,7 @@ public interface ExtendedLogger extends Logger { * @param p0 the message parameters * @param p1 the message parameters * @param p2 the message parameters + * @since 2.6 */ void logIfEnabled(String fqcn, Level level, Marker marker, String message, Object p0, Object p1, Object p2); @@ -427,6 +442,7 @@ public interface ExtendedLogger extends Logger { * @param p1 the message parameters * @param p2 the message parameters * @param p3 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3); @@ -444,6 +460,7 @@ public interface ExtendedLogger extends Logger { * @param p2 the message parameters * @param p3 the message parameters * @param p4 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, @@ -470,6 +487,7 @@ public interface ExtendedLogger extends Logger { * @param p3 the message parameters * @param p4 the message parameters * @param p5 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, @@ -498,6 +516,7 @@ public interface ExtendedLogger extends Logger { * @param p4 the message parameters * @param p5 the message parameters * @param p6 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, @@ -528,6 +547,7 @@ public interface ExtendedLogger extends Logger { * @param p5 the message parameters * @param p6 the message parameters * @param p7 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, @@ -560,6 +580,7 @@ public interface ExtendedLogger extends Logger { * @param p6 the message parameters * @param p7 the message parameters * @param p8 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, @@ -594,6 +615,7 @@ public interface ExtendedLogger extends Logger { * @param p7 the message parameters * @param p8 the message parameters * @param p9 the message parameters + * @since 2.6 */ void logIfEnabled( String fqcn, diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggerRegistry.java b/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggerRegistry.java index bd27af9ffd..4274337b14 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggerRegistry.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/spi/LoggerRegistry.java @@ -36,6 +36,7 @@ import org.jspecify.annotations.Nullable; /** * Convenience class to be used as an {@link ExtendedLogger} registry by {@code LoggerContext} implementations. + * @since 2.6 */ @NullMarked public class LoggerRegistry<T extends ExtendedLogger> { @@ -52,6 +53,7 @@ public class LoggerRegistry<T extends ExtendedLogger> { * Data structure contract for the internal storage of admitted loggers. * * @param <T> subtype of {@code ExtendedLogger} + * @since 2.6 * @deprecated As of version {@code 2.25.0}, planned to be removed! */ @Deprecated @@ -68,6 +70,7 @@ public class LoggerRegistry<T extends ExtendedLogger> { * {@link MapFactory} implementation using {@link ConcurrentHashMap}. * * @param <T> subtype of {@code ExtendedLogger} + * @since 2.6 * @deprecated As of version {@code 2.25.0}, planned to be removed! */ @Deprecated @@ -93,6 +96,7 @@ public class LoggerRegistry<T extends ExtendedLogger> { * {@link MapFactory} implementation using {@link WeakHashMap}. * * @param <T> subtype of {@code ExtendedLogger} + * @since 2.6 * @deprecated As of version {@code 2.25.0}, planned to be removed! */ @Deprecated 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 64938962a9..87e638096b 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 @@ -633,6 +633,7 @@ public class StatusLogger extends AbstractLogger { * Sets the level of the fallback listener. * * @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 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 2fac29a019..c02fd6c8d4 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 @@ -81,6 +81,7 @@ public final class LambdaUtil { * @param supplier a lambda expression or {@code null} * @return the Message resulting from evaluating the lambda expression or the Message created by the factory for * supplied values that are not of type Message + * @since 2.6 */ public static Message getMessage(final Supplier<?> supplier, final MessageFactory messageFactory) { if (supplier == null) { 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 0daa5798d9..2679cd44f4 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 @@ -270,6 +270,7 @@ public final class PropertiesUtil { * @param name the name of the property to look up * @param defaultValue the default value to use if the property is undefined * @return the parsed double value of the property or {@code defaultValue} if it was undefined or could not be parsed. + * @since 2.6 */ public double getDoubleProperty(final String name, final double defaultValue) { final String prop = getStringProperty(name); diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/Strings.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/Strings.java index b6a085f62f..f8da867d60 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/Strings.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/Strings.java @@ -310,6 +310,7 @@ public final class Strings { * @param str The string to lower case. * @return a new string * @see String#toLowerCase(Locale) + * @since 2.6 */ public static String toRootUpperCase(final String str) { return str.toUpperCase(Locale.ROOT);
