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 b3391efb08627368fb96533cc8f1db033a6b8984 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sun Dec 29 10:26:24 2024 +0100 Document `log4j-api` changes in version 2.22.0 --- .../src/main/java/org/apache/logging/log4j/spi/AbstractLogger.java | 3 +++ .../src/main/java/org/apache/logging/log4j/util/Base64Util.java | 1 + log4j-api/src/main/java/org/apache/logging/log4j/util/Cast.java | 3 +++ .../main/java/org/apache/logging/log4j/util/InternalException.java | 2 ++ log4j-api/src/main/java/org/apache/logging/log4j/util/Lazy.java | 1 + .../src/main/java/org/apache/logging/log4j/util/LazyBoolean.java | 3 +++ .../src/main/java/org/apache/logging/log4j/util/LoaderUtil.java | 6 +++++- 7 files changed, 18 insertions(+), 1 deletion(-) 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 261fe2a25f..4ed9e6f8a6 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 @@ -687,6 +687,9 @@ public abstract class AbstractLogger implements ExtendedLogger, LocationAwareLog entry(FQCN, (Object[]) null); } + /** + * @deprecated since 2.22.0, use {@link #traceEntry(String, Object...)} instead. + */ @Deprecated @Override public void entry(final Object... params) { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/Base64Util.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/Base64Util.java index f952b91533..4733c1df36 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/Base64Util.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/Base64Util.java @@ -56,6 +56,7 @@ public final class Base64Util { /** * This method does not specify an encoding for the {@code str} parameter and should not be used. + * @deprecated since 2.22.0, use {@link java.util.Base64} instead. */ @Deprecated public static String encode(final String str) { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/Cast.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/Cast.java index df97c336ee..46f6954cc0 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/Cast.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/Cast.java @@ -16,6 +16,9 @@ */ package org.apache.logging.log4j.util; +/** + * @since 2.22.0 + */ @InternalApi public final class Cast { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/InternalException.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/InternalException.java index 486aa8b84d..2c011d4343 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/InternalException.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/InternalException.java @@ -19,6 +19,8 @@ package org.apache.logging.log4j.util; /** * Exception thrown when an error occurs while accessing internal resources. This is generally used to * convert checked exceptions to runtime exceptions. + * + * @since 2.22.0 */ public class InternalException extends RuntimeException { diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/Lazy.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/Lazy.java index 2e0d84b3ce..3af4ed46a0 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/Lazy.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/Lazy.java @@ -24,6 +24,7 @@ import java.util.function.Supplier; * Provides a lazily-initialized value from a {@code Supplier<T>}. * * @param <T> type of value + * @since 2.22.0 */ public interface Lazy<T> extends Supplier<T> { /** diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/LazyBoolean.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/LazyBoolean.java index 26db8639de..f287aae11c 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/LazyBoolean.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/LazyBoolean.java @@ -20,6 +20,9 @@ import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; import java.util.function.BooleanSupplier; +/** + * @since 2.22.0 + */ public class LazyBoolean implements BooleanSupplier { private final BooleanSupplier supplier; private final Lock lock = new ReentrantLock(); diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java index 718b00889a..b326734ccb 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/LoaderUtil.java @@ -87,11 +87,15 @@ public final class LoaderUtil { * Returns the ClassLoader to use. * * @return the ClassLoader. + * @since 2.22.0 */ public static ClassLoader getClassLoader() { return getClassLoader(LoaderUtil.class, null); } + /** + * @since 2.22.0 + */ // TODO: this method could use some explanation public static ClassLoader getClassLoader(final Class<?> class1, final Class<?> class2) { PrivilegedAction<ClassLoader> action = () -> { @@ -350,7 +354,7 @@ public final class LoaderUtil { * @throws IllegalAccessException if the class can't be instantiated through a public constructor * @throws InstantiationException if the provided class is abstract or an interface * @throws InvocationTargetException if an exception is thrown by the constructor - * @since 2.22 + * @since 2.22.0 */ public static <T> T newCheckedInstanceOfProperty( final String propertyName, final Class<T> clazz, final Supplier<T> defaultSupplier)
