org.apache.avalon.composition.data
Class CategoriesDirective

java.lang.Object
  extended byorg.apache.avalon.composition.data.CategoryDirective
      extended byorg.apache.avalon.composition.data.CategoriesDirective
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
LoggingDescriptor

public class CategoriesDirective
extends CategoryDirective
implements Serializable

Description of a set of categories.

Version:
$Revision: 1.1.1.1 $ $Date: 2003/08/31 14:26:46 $
Author:
Avalon Development Team
See Also:
CategoryDirective, Serialized Form

Field Summary
 
Fields inherited from class org.apache.avalon.composition.data.CategoryDirective
DEBUG, ERROR, INFO, WARN
 
Constructor Summary
CategoriesDirective()
          Create a CategoriesDirective instance.
CategoriesDirective(CategoryDirective[] categories)
          Create a CategoriesDirective instance.
CategoriesDirective(String name)
          Create a CategoriesDirective instance.
CategoriesDirective(String name, String priority, String target, CategoryDirective[] categories)
          Create a CategoriesDirective instance.
 
Method Summary
 boolean equals(Object other)
          Test this object for equality with the suppplied object.
 CategoryDirective[] getCategories()
          Return the set of logging categories.
 CategoryDirective getCategoryDirective(String name)
          Return a named category.
 int hashCode()
          Return the hashcode for the object.
 
Methods inherited from class org.apache.avalon.composition.data.CategoryDirective
getName, getPriority, getTarget
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoriesDirective

public CategoriesDirective()
Create a CategoriesDirective instance.


CategoriesDirective

public CategoriesDirective(String name)
Create a CategoriesDirective instance.

Parameters:
name - the base category name

CategoriesDirective

public CategoriesDirective(CategoryDirective[] categories)
Create a CategoriesDirective instance.

Parameters:
categories - the categories to include in the directive

CategoriesDirective

public CategoriesDirective(String name,
                           String priority,
                           String target,
                           CategoryDirective[] categories)
Create a CategoriesDirective instance.

Parameters:
name - the base category name
priority - the default logging priority
target - the default logging target
categories - the logging category descriptors
Method Detail

getCategories

public CategoryDirective[] getCategories()
Return the set of logging categories.

Returns:
the set of category declarations

getCategoryDirective

public CategoryDirective getCategoryDirective(String name)
Return a named category.

Parameters:
name - the category name
Returns:
the category declaration

equals

public boolean equals(Object other)
Test this object for equality with the suppplied object.

Overrides:
equals in class CategoryDirective
Returns:
TRUE if this object equals the supplied object else FALSE

hashCode

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

Overrides:
hashCode in class CategoryDirective
Returns:
the cashcode


Copyright © Apache Software Foundation. All Rights Reserved.