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 916dbc52857a8891fd342ea8bce84443cbc294dc Author: Piotr P. Karwasz <[email protected]> AuthorDate: Sun Dec 29 10:06:58 2024 +0100 Document `log4j-api` changes in version 2.18.0 --- .../org/apache/logging/log4j/message/StructuredDataId.java | 12 ++++++++---- .../org/apache/logging/log4j/util/OsgiServiceLocator.java | 3 +++ .../apache/logging/log4j/util/PropertiesPropertySource.java | 3 +++ .../logging/log4j/util/PropertyFilePropertySource.java | 3 +++ .../java/org/apache/logging/log4j/util/PropertySource.java | 1 + .../org/apache/logging/log4j/util/ServiceLoaderUtil.java | 2 ++ 6 files changed, 20 insertions(+), 4 deletions(-) diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java index 002867991a..f8b65d9a81 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataId.java @@ -46,6 +46,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable /** * Reserved enterprise number. + * @since 2.18.0 */ public static final String RESERVED = "-1"; @@ -127,6 +128,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * @param enterpriseNumber The enterprise number. * @param required The list of keys that are required for this id. * @param optional The list of keys that are optional for this id. + * @since 2.18.0 */ public StructuredDataId( final String name, final String enterpriseNumber, final String[] required, final String[] optional) { @@ -140,7 +142,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * @param enterpriseNumber The enterprise number. * @param required The list of keys that are required for this id. * @param optional The list of keys that are optional for this id. - * @deprecated Use {@link #StructuredDataId(String, String, String[], String[])} instead. + * @deprecated Since 2.18.0, use {@link #StructuredDataId(String, String, String[], String[])} instead. */ @Deprecated @InlineMe(replacement = "this(name, String.valueOf(enterpriseNumber), required, optional)") @@ -157,7 +159,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * @param required The list of keys that are required for this id. * @param optional The list of keys that are optional for this id. * @param maxLength The maximum length of the StructuredData Id key. - * @since 2.9 + * @since 2.18.0 */ public StructuredDataId( final String name, @@ -193,7 +195,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * @param optional The list of keys that are optional for this id. * @param maxLength The maximum length of the StructuredData Id key. * @since 2.9.0 - * @deprecated Use {@link #StructuredDataId(String, String, String[], String[], int)} instead. + * @deprecated Since 2.18.0, use {@link #StructuredDataId(String, String, String[], String[], int)} instead. */ @InlineMe(replacement = "this(name, String.valueOf(enterpriseNumber), required, optional, maxLength)") @Deprecated @@ -225,6 +227,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * @param defaultId The default id to use if this StructuredDataId doesn't have a name. * @param anEnterpriseNumber The enterprise number. * @return a StructuredDataId. + * @since 2.18.0 */ public StructuredDataId makeId(final String defaultId, final String anEnterpriseNumber) { String id; @@ -252,7 +255,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * @param defaultId The default id to use if this StructuredDataId doesn't have a name. * @param anEnterpriseNumber The enterprise number. * @return a StructuredDataId. - * @deprecated Use {@link StructuredDataId#makeId(String, String)} instead + * @deprecated Since 2.18.0, use {@link StructuredDataId#makeId(String, String)} instead */ @Deprecated // This method should have been `final` from the start, we don't expect anyone to override it. @@ -292,6 +295,7 @@ public class StructuredDataId implements Serializable, StringBuilderFormattable * Returns the enterprise number. * * @return the enterprise number. + * @since 2.18.0 */ public String getEnterpriseNumber() { return enterpriseNumber; diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/OsgiServiceLocator.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/OsgiServiceLocator.java index 46157290c1..26eeae1718 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/OsgiServiceLocator.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/OsgiServiceLocator.java @@ -26,6 +26,9 @@ import org.osgi.framework.BundleContext; import org.osgi.framework.FrameworkUtil; import org.osgi.framework.wiring.BundleRevision; +/** + * @since 2.18.0 + */ public class OsgiServiceLocator { private static final Logger LOGGER = StatusLogger.getLogger(); diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesPropertySource.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesPropertySource.java index 311247c85f..8ff065ecce 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesPropertySource.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesPropertySource.java @@ -38,6 +38,9 @@ public class PropertiesPropertySource implements PropertySource { this(properties, DEFAULT_PRIORITY); } + /** + * @since 2.18.0 + */ public PropertiesPropertySource(final Properties properties, final int priority) { this.properties = properties; this.priority = priority; diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertyFilePropertySource.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertyFilePropertySource.java index 3440af0460..acb4310c3c 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertyFilePropertySource.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertyFilePropertySource.java @@ -37,6 +37,9 @@ public class PropertyFilePropertySource extends PropertiesPropertySource { this(fileName, true); } + /** + * @since 2.18.0 + */ public PropertyFilePropertySource(final String fileName, final boolean useTccl) { super(loadPropertiesFile(fileName, useTccl)); } diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertySource.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertySource.java index 399c4ea010..63c8173c44 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertySource.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/PropertySource.java @@ -56,6 +56,7 @@ public interface PropertySource { * Returns the list of all property names. * * @return list of property names + * @since 2.18.0 */ default Collection<String> getPropertyNames() { return Collections.emptySet(); diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/util/ServiceLoaderUtil.java b/log4j-api/src/main/java/org/apache/logging/log4j/util/ServiceLoaderUtil.java index cbd0b4de0b..38d6702b33 100644 --- a/log4j-api/src/main/java/org/apache/logging/log4j/util/ServiceLoaderUtil.java +++ b/log4j-api/src/main/java/org/apache/logging/log4j/util/ServiceLoaderUtil.java @@ -47,6 +47,8 @@ import org.apache.logging.log4j.Logger; * <li>skip faulty services, allowing for a partial retrieval of the good ones,</li> * <li>allow to integrate other sources of services like OSGi services.</li> * </ol> + * + * @since 2.18.0 */ @InternalApi public final class ServiceLoaderUtil {
