Author: rdonkin
Date: Sat Feb 11 13:20:55 2006
New Revision: 377058
URL: http://svn.apache.org/viewcvs?rev=377058&view=rev
Log:
Java documentation improvements: added notes about the value of the constants
describes where they might be useful to a user.
Modified:
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/LogFactory.java
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java
Modified:
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/LogFactory.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/LogFactory.java?rev=377058&r1=377057&r2=377058&view=diff
==============================================================================
---
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/LogFactory.java
(original)
+++
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/LogFactory.java
Sat Feb 11 13:20:55 2006
@@ -54,21 +54,22 @@
// ----------------------------------------------------- Manifest Constants
/**
- * The name of the key in the config file used to specify the priority of
- * that particular config file. The associated value is a floating-point
- * number; higher values take priority over lower values.
+ * The name (<code>priority</code>) of the key in the config file used to
+ * specify the priority of that particular config file. The associated
value
+ * is a floating-point number; higher values take priority over lower
values.
*/
public static final String PRIORITY_KEY = "priority";
/**
- * The name of the key in the config file used to specify whether logging
- * classes should be loaded via the thread context class loader (TCCL),
- * or not. By default, the TCCL is used.
+ * The name (<code>use_tccl</code>) of the key in the config file used
+ * to specify whether logging classes should be loaded via the thread
+ * context class loader (TCCL), or not. By default, the TCCL is used.
*/
public static final String TCCL_KEY = "use_tccl";
/**
- * The name of the property used to identify the LogFactory implementation
+ * The name (<code>org.apache.commons.logging.LogFactory</code>) of the
property
+ * used to identify the LogFactory implementation
* class name. This can be used as a system property, or as an entry in a
* configuration properties file.
*/
@@ -83,7 +84,7 @@
"org.apache.commons.logging.impl.LogFactoryImpl";
/**
- * The name of the properties file to search for.
+ * The name (<code>commons-logging.properties</code>) of the properties
file to search for.
*/
public static final String FACTORY_PROPERTIES =
"commons-logging.properties";
@@ -97,7 +98,8 @@
"META-INF/services/org.apache.commons.logging.LogFactory";
/**
- * The name of the property used to enable internal commons-logging
+ * The name (<code>org.apache.commons.logging.diagnostics.dest</code>)
+ * of the property used to enable internal commons-logging
* diagnostic output, in order to get information on what logging
* implementations are being discovered, what classloaders they
* are loaded through, etc.
@@ -106,6 +108,9 @@
* assumed to be the name of a file. The special strings
* STDOUT or STDERR (case-sensitive) indicate output to
* System.out and System.err respectively.
+ * <p>
+ * Diagnostic logging should be used only to debug problematic
+ * configurations and should not be set in normal production use.
*/
public static final String DIAGNOSTICS_DEST_PROPERTY =
"org.apache.commons.logging.diagnostics.dest";
@@ -125,7 +130,9 @@
private static String diagnosticPrefix;
/**
- * <p>Setting this system property value allows the <code>Hashtable</code>
used to store
+ * <p>Setting this system property
+ * (<code>org.apache.commons.logging.LogFactory.HashtableImpl</code>)
+ * value allows the <code>Hashtable</code> used to store
* classloaders to be substituted by an alternative implementation.
* </p>
* <p>
@@ -161,7 +168,8 @@
public static final String HASHTABLE_IMPLEMENTATION_PROPERTY =
"org.apache.commons.logging.LogFactory.HashtableImpl";
/** Name used to load the weak hashtable implementation by names */
- private static final String WEAK_HASHTABLE_CLASSNAME =
"org.apache.commons.logging.impl.WeakHashtable";
+ private static final String WEAK_HASHTABLE_CLASSNAME =
+ "org.apache.commons.logging.impl.WeakHashtable";
/**
* A reference to the classloader that loaded this class. This is the
Modified:
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java?rev=377058&r1=377057&r2=377058&view=diff
==============================================================================
---
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java
(original)
+++
jakarta/commons/proper/logging/trunk/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java
Sat Feb 11 13:20:55 2006
@@ -95,8 +95,8 @@
/**
- * The name of the system property identifying our [EMAIL PROTECTED] Log}
- * implementation class.
+ * The name (<code>org.apache.commons.logging.Log</code>) of the system
+ * property identifying our [EMAIL PROTECTED] Log} implementation class.
*/
public static final String LOG_PROPERTY =
"org.apache.commons.logging.Log";
@@ -104,13 +104,14 @@
/**
* The deprecated system property used for backwards compatibility with
- * the old [EMAIL PROTECTED] org.apache.commons.logging.LogSource} class.
+ * old versions of JCL.
*/
protected static final String LOG_PROPERTY_OLD =
"org.apache.commons.logging.log";
/**
- * The name of the system property which can be set true/false to
+ * The name
(<code>org.apache.commons.logging.Log.allowFlawedContext</code>)
+ * of the system property which can be set true/false to
* determine system behaviour when a bad context-classloader is
encountered.
* When set to false
*
@@ -122,7 +123,8 @@
"org.apache.commons.logging.Log.allowFlawedContext";
/**
- * The name of the system property which can be set true/false to
+ * The name
(<code>org.apache.commons.logging.Log.allowFlawedDiscovery</code>)
+ * of the system property which can be set true/false to
* determine system behaviour when a bad logging adapter class is
* encountered during logging discovery. When set to false, an
* exception will be thrown and the app will fail to start. When set
@@ -137,7 +139,8 @@
"org.apache.commons.logging.Log.allowFlawedDiscovery";
/**
- * The name of the system property which can be set true/false to
+ * The name
(<code>org.apache.commons.logging.Log.allowFlawedHierarchy</code>)
+ * of the system property which can be set true/false to
* determine system behaviour when a logging adapter class is
* encountered which has bound to the wrong Log class implementation.
* When set to false, an exception will be thrown and the app will fail
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
