net.dpml.metro.info
Class CategoryDescriptor

java.lang.Object
  net.dpml.metro.info.Descriptor
      net.dpml.metro.info.CategoryDescriptor

All Implemented Interfaces:

Serializable

public class CategoryDescriptor

extends Descriptor

A category descriptor describes a logging channel that a component type uses.

Version:

1.0.1

Author:

Digital Product Meta Library

See Also:

Serialized Form

Field Summary

static Priority	PRIORITY Default priority value.
static String	SEPERATOR Constant category separator.

Constructor Summary

CategoryDescriptor(String name, Priority priority, Properties attributes)
Create a descriptor for logging category.

Method Summary

boolean	equals(Object other) Test is the supplied object is equal to this object.
Priority	getDefaultPriority() Return the default logging priority.
String	getName() Return the name of logging category.
int	hashCode() Return the hashcode for the object.

Methods inherited from class net.dpml.metro.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

Constant category separator.

See Also:

Constant Field Values

PRIORITY

public static final Priority PRIORITY

Default priority value.

Constructor Detail

CategoryDescriptor

public CategoryDescriptor(String name,
                          Priority priority,
                          Properties attributes)
                   throws NullPointerException

Create a descriptor for logging category.

Parameters:

name - the logging category name

priority - the default priority value

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.

getDefaultPriority

public Priority getDefaultPriority()

Return the default logging priority.

Returns:

the default priority.

equals

public boolean equals(Object other)

Test is the supplied object is equal to this object.

Overrides:

equals in class Descriptor

Parameters:

other - the other object

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