org.apache.avalon.meta.info
Class CategoryDescriptor

java.lang.Object
  extended byorg.apache.avalon.meta.info.Descriptor
      extended byorg.apache.avalon.meta.info.CategoryDescriptor
All Implemented Interfaces:
Serializable

public class CategoryDescriptor
extends Descriptor

A descriptor describing an Avalon Logger child instances that the component will create using the org.apache.avalon.framework.logger.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 m_logger.getChildLogger( "data" );. The establishment of logging channels and targets for the returned channel is container concern facilities by type-level category declarations.

Also associated with each Logger is a set of arbitrary attributes that can be used to store extra information about Logger requirements.

Version:
$Revision: 1.1.1.1 $ $Date: 2003/09/24 08:15:03 $
Author:
Avalon Development Team
See Also:
Serialized Form

Field Summary
static String SEPERATOR
           
 
Constructor Summary
CategoryDescriptor(String name, Properties attributes)
          Create a descriptor for logging category.
 
Method Summary
 boolean equals(Object other)
          Test is the supplied object is equal to this object.
 String getName()
          Return the name of logging category.
 int hashCode()
          Return the hashcode for the object.
 
Methods inherited from class org.apache.avalon.meta.info.Descriptor
getAttribute, getAttribute, getAttributeNames, getProperties
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEPERATOR

public static final String SEPERATOR
See Also:
Constant Field Values
Constructor Detail

CategoryDescriptor

public CategoryDescriptor(String name,
                          Properties attributes)
                   throws NullPointerException
Create a descriptor for logging category.

Parameters:
name - the logging category name
attributes - a set of attributes associated with the declaration
Throws:
NullPointerException - if name argument is null
Method Detail

getName

public String getName()
Return the name of logging category.

Returns:
the category name.

equals

public boolean equals(Object other)
Test is the supplied object is equal to this object.

Overrides:
equals in class Descriptor
Parameters:
other - the object to compare this object with
Returns:
true if the object are equivalent

hashCode

public int hashCode()
Return the hashcode for the object.

Overrides:
hashCode in class Descriptor
Returns:
the hashcode value


Copyright © Apache Software Foundation. All Rights Reserved.