mcconnell 2003/07/10 14:44:13
Modified: meta/api/src/java/org/apache/avalon/meta/info
CategoryDescriptor.java
Log:
Improving class javadoc.
Revision Changes Path
1.2 +15 -8
avalon-sandbox/meta/api/src/java/org/apache/avalon/meta/info/CategoryDescriptor.java
Index: CategoryDescriptor.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/meta/api/src/java/org/apache/avalon/meta/info/CategoryDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CategoryDescriptor.java 10 Jul 2003 21:19:08 -0000 1.1
+++ CategoryDescriptor.java 10 Jul 2003 21:44:13 -0000 1.2
@@ -53,10 +53,15 @@
import java.util.Properties;
/**
- * A descriptor describing the Loggers that the Component
- * will use. The name of each Logger is relative to the
- * Logger passed to the component (namespace separator is '.').
- * "" names root logger.
+ * A descriptor describing the [EMAIL PROTECTED]
org.apache.avalon.framework.Logger}
+ * child instances that the component will create using the
+ * [EMAIL PROTECTED] org.apache.avalon.framework.Logger#getChildLogger}
+ * method. The name of each category is relative to the component. For
+ * example, a component with an internal logging category named "data"
+ * would aquire a logger for that category using the
+ * <code>m_logger.getChildLogger( "data" );</code>. The establishment
+ * of logging channels and targets for the returned channel is container
+ * concern facilities by type-level category declarations.
*
* <p>Also associated with each Logger is a set of arbitrary
* attributes that can be used to store extra information
@@ -68,10 +73,12 @@
public class CategoryDescriptor
extends Descriptor
{
+ public static final String SEPERATOR = ".";
+
private final String m_name;
/**
- * Create a descriptor for Logger.
+ * Create a descriptor for logging category.
*
* @param name the logging category name
* @param attributes a set of attributes associated with the declaration
@@ -92,9 +99,9 @@
}
/**
- * Return the name of logger.
+ * Return the name of logging category.
*
- * @return the name of Logger.
+ * @return the category name.
*/
public String getName()
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
