From 506707c7e2357d873d0f1a139615a25633b6d482 Mon Sep 17 00:00:00 2001 From: Robert Burrell Donkin Date: Sun, 22 Jan 2006 22:07:31 +0000 Subject: [PATCH] Added @since tags as recommended in the release best practices document. git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@371403 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/commons/logging/LogFactory.java | 7 +++++++ .../apache/commons/logging/impl/Jdk13LumberjackLogger.java | 1 + .../org/apache/commons/logging/impl/LogFactoryImpl.java | 5 ++++- .../apache/commons/logging/impl/ServletContextCleaner.java | 2 ++ .../org/apache/commons/logging/impl/WeakHashtable.java | 2 ++ 5 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/java/org/apache/commons/logging/LogFactory.java b/src/java/org/apache/commons/logging/LogFactory.java index bc94695..1707369 100644 --- a/src/java/org/apache/commons/logging/LogFactory.java +++ b/src/java/org/apache/commons/logging/LogFactory.java @@ -685,6 +685,7 @@ public abstract class LogFactory { * just disable all commons-logging? Not high priority though - as stated * above, security policies that prevent classloader access aren't common. * + * @since 1.1 */ protected static ClassLoader getClassLoader(Class clazz) { try { @@ -746,6 +747,7 @@ public abstract class LogFactory { * @exception SecurityException if the java security policy forbids * access to the context classloader from one of the classes in the * current call stack. + * @since 1.1 */ protected static ClassLoader directGetContextClassLoader() throws LogConfigurationException @@ -910,6 +912,7 @@ public abstract class LogFactory { * * @exception LogConfigurationException if a suitable instance * cannot be created + * @since 1.1 */ protected static LogFactory newFactory(final String factoryClass, final ClassLoader classLoader, @@ -965,6 +968,7 @@ public abstract class LogFactory { * @param classLoader * * @return either a LogFactory object or a LogConfigurationException object. + * @since 1.1 */ protected static Object createFactory(String factoryClass, ClassLoader classLoader) { @@ -1270,6 +1274,7 @@ public abstract class LogFactory { * areDiagnosticsEnabled just isn't java beans style. * * @return true if calls to logDiagnostic will have any effect. + * @since 1.1 */ protected static boolean isDiagnosticsEnabled() { return diagnosticsStream != null; @@ -1305,6 +1310,7 @@ public abstract class LogFactory { * Write the specified message to the internal logging destination. * * @param msg is the diagnostic message to be output. + * @since 1.1 */ protected static final void logRawDiagnostic(String msg) { if (diagnosticsStream != null) { @@ -1395,6 +1401,7 @@ public abstract class LogFactory { * * @param o may be null. * @return a string of form classname@hashcode, or "null" if param o is null. + * @since 1.1 */ public static String objectId(Object o) { if (o == null) { diff --git a/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java b/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java index b996fec..1cf5cb2 100644 --- a/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java +++ b/src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java @@ -39,6 +39,7 @@ import org.apache.commons.logging.Log; * @author Peter Donald * @author Vince Eagen * @version $Revision$ $Date$ + * @since 1.1 */ public class Jdk13LumberjackLogger implements Log, Serializable { diff --git a/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java b/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java index bf48fb7..1569381 100644 --- a/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java +++ b/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java @@ -397,6 +397,7 @@ public class LogFactoryImpl extends LogFactory { /** * Gets the context classloader. * This method is a workaround for a java 1.2 compiler bug. + * @since 1.1 */ protected static ClassLoader getContextClassLoader() throws LogConfigurationException { return LogFactory.getContextClassLoader(); @@ -415,6 +416,7 @@ public class LogFactoryImpl extends LogFactory { /** * Workaround for bug in Java1.2; in theory this method is not needed. * See LogFactory.getClassLoader. + * @since 1.1 */ protected static ClassLoader getClassLoader(Class clazz) { return LogFactory.getClassLoader(clazz); @@ -453,7 +455,8 @@ public class LogFactoryImpl extends LogFactory { * Output a diagnostic message to a user-specified destination (if the * user has enabled diagnostic logging). * - * @param msg + * @param msg diagnostic message + * @since 1.1 */ protected void logDiagnostic(String msg) { if (isDiagnosticsEnabled()) { diff --git a/src/java/org/apache/commons/logging/impl/ServletContextCleaner.java b/src/java/org/apache/commons/logging/impl/ServletContextCleaner.java index 426fc4b..2dd6fe3 100644 --- a/src/java/org/apache/commons/logging/impl/ServletContextCleaner.java +++ b/src/java/org/apache/commons/logging/impl/ServletContextCleaner.java @@ -48,6 +48,8 @@ import org.apache.commons.logging.LogFactory; * this class on webapp undeploy; the contextDestroyed method will tell * LogFactory that the entry in its map for the current webapp's context * classloader should be cleared. + * + * @since 1.1 */ public class ServletContextCleaner implements ServletContextListener { diff --git a/src/java/org/apache/commons/logging/impl/WeakHashtable.java b/src/java/org/apache/commons/logging/impl/WeakHashtable.java index 232b365..f92ef3f 100644 --- a/src/java/org/apache/commons/logging/impl/WeakHashtable.java +++ b/src/java/org/apache/commons/logging/impl/WeakHashtable.java @@ -116,6 +116,8 @@ import java.util.*; * * * @author Brian Stansberry + * + * @since 1.1 */ public final class WeakHashtable extends Hashtable {