1
0

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
This commit is contained in:
Robert Burrell Donkin
2006-01-22 22:07:31 +00:00
parent a2eb0564f1
commit 506707c7e2
5 changed files with 16 additions and 1 deletions

View File

@@ -685,6 +685,7 @@ public abstract class LogFactory {
* just disable all commons-logging? Not high priority though - as stated * just disable all commons-logging? Not high priority though - as stated
* above, security policies that prevent classloader access aren't common. * above, security policies that prevent classloader access aren't common.
* *
* @since 1.1
*/ */
protected static ClassLoader getClassLoader(Class clazz) { protected static ClassLoader getClassLoader(Class clazz) {
try { try {
@@ -746,6 +747,7 @@ public abstract class LogFactory {
* @exception SecurityException if the java security policy forbids * @exception SecurityException if the java security policy forbids
* access to the context classloader from one of the classes in the * access to the context classloader from one of the classes in the
* current call stack. * current call stack.
* @since 1.1
*/ */
protected static ClassLoader directGetContextClassLoader() protected static ClassLoader directGetContextClassLoader()
throws LogConfigurationException throws LogConfigurationException
@@ -910,6 +912,7 @@ public abstract class LogFactory {
* *
* @exception LogConfigurationException if a suitable instance * @exception LogConfigurationException if a suitable instance
* cannot be created * cannot be created
* @since 1.1
*/ */
protected static LogFactory newFactory(final String factoryClass, protected static LogFactory newFactory(final String factoryClass,
final ClassLoader classLoader, final ClassLoader classLoader,
@@ -965,6 +968,7 @@ public abstract class LogFactory {
* @param classLoader * @param classLoader
* *
* @return either a LogFactory object or a LogConfigurationException object. * @return either a LogFactory object or a LogConfigurationException object.
* @since 1.1
*/ */
protected static Object createFactory(String factoryClass, ClassLoader classLoader) { protected static Object createFactory(String factoryClass, ClassLoader classLoader) {
@@ -1270,6 +1274,7 @@ public abstract class LogFactory {
* areDiagnosticsEnabled just isn't java beans style. * areDiagnosticsEnabled just isn't java beans style.
* *
* @return true if calls to logDiagnostic will have any effect. * @return true if calls to logDiagnostic will have any effect.
* @since 1.1
*/ */
protected static boolean isDiagnosticsEnabled() { protected static boolean isDiagnosticsEnabled() {
return diagnosticsStream != null; return diagnosticsStream != null;
@@ -1305,6 +1310,7 @@ public abstract class LogFactory {
* Write the specified message to the internal logging destination. * Write the specified message to the internal logging destination.
* *
* @param msg is the diagnostic message to be output. * @param msg is the diagnostic message to be output.
* @since 1.1
*/ */
protected static final void logRawDiagnostic(String msg) { protected static final void logRawDiagnostic(String msg) {
if (diagnosticsStream != null) { if (diagnosticsStream != null) {
@@ -1395,6 +1401,7 @@ public abstract class LogFactory {
* *
* @param o may be null. * @param o may be null.
* @return a string of form classname@hashcode, or "null" if param o is null. * @return a string of form classname@hashcode, or "null" if param o is null.
* @since 1.1
*/ */
public static String objectId(Object o) { public static String objectId(Object o) {
if (o == null) { if (o == null) {

View File

@@ -39,6 +39,7 @@ import org.apache.commons.logging.Log;
* @author <a href="mailto:donaldp@apache.org">Peter Donald</a> * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
* @author <a href="mailto:vince256@comcast.net">Vince Eagen</a> * @author <a href="mailto:vince256@comcast.net">Vince Eagen</a>
* @version $Revision$ $Date$ * @version $Revision$ $Date$
* @since 1.1
*/ */
public class Jdk13LumberjackLogger implements Log, Serializable { public class Jdk13LumberjackLogger implements Log, Serializable {

View File

@@ -397,6 +397,7 @@ public class LogFactoryImpl extends LogFactory {
/** /**
* Gets the context classloader. * Gets the context classloader.
* This method is a workaround for a java 1.2 compiler bug. * This method is a workaround for a java 1.2 compiler bug.
* @since 1.1
*/ */
protected static ClassLoader getContextClassLoader() throws LogConfigurationException { protected static ClassLoader getContextClassLoader() throws LogConfigurationException {
return LogFactory.getContextClassLoader(); 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. * Workaround for bug in Java1.2; in theory this method is not needed.
* See LogFactory.getClassLoader. * See LogFactory.getClassLoader.
* @since 1.1
*/ */
protected static ClassLoader getClassLoader(Class clazz) { protected static ClassLoader getClassLoader(Class clazz) {
return LogFactory.getClassLoader(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 * Output a diagnostic message to a user-specified destination (if the
* user has enabled diagnostic logging). * user has enabled diagnostic logging).
* *
* @param msg * @param msg diagnostic message
* @since 1.1
*/ */
protected void logDiagnostic(String msg) { protected void logDiagnostic(String msg) {
if (isDiagnosticsEnabled()) { if (isDiagnosticsEnabled()) {

View File

@@ -48,6 +48,8 @@ import org.apache.commons.logging.LogFactory;
* this class on webapp undeploy; the contextDestroyed method will tell * this class on webapp undeploy; the contextDestroyed method will tell
* LogFactory that the entry in its map for the current webapp's context * LogFactory that the entry in its map for the current webapp's context
* classloader should be cleared. * classloader should be cleared.
*
* @since 1.1
*/ */
public class ServletContextCleaner implements ServletContextListener { public class ServletContextCleaner implements ServletContextListener {

View File

@@ -116,6 +116,8 @@ import java.util.*;
* *
* *
* @author Brian Stansberry * @author Brian Stansberry
*
* @since 1.1
*/ */
public final class WeakHashtable extends Hashtable { public final class WeakHashtable extends Hashtable {