org.opends.server.loggers
Class LogCategory

java.lang.Object
  extended by org.opends.server.loggers.LogCategory
Direct Known Subclasses:
DebugLogCategory

public class LogCategory
extends java.lang.Object

The category class defines a set of standard logging types that can be used to control logging output.


Constructor Summary
protected LogCategory(java.lang.String name)
          Create a named type.
 
Method Summary
 java.lang.String getName()
          Return the non-localized string name of the Level.
static LogCategory parse(java.lang.String name)
          Parse a category name string into a LogCategory.
 java.lang.String toString()
          Retrieves the string reprentation of this log category.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LogCategory

protected LogCategory(java.lang.String name)
Create a named type.

Note that this constructor is "protected" to allow subclassing.

Parameters:
name - the name of the category, for example "MESSAGE".
Method Detail

getName

public java.lang.String getName()
Return the non-localized string name of the Level.

Returns:
non-localized name

toString

public final java.lang.String toString()
Retrieves the string reprentation of this log category.

Overrides:
toString in class java.lang.Object
Returns:
the non-localized name of the LogCategory, for example "ENTRY".

parse

public static LogCategory parse(java.lang.String name)
                         throws java.lang.IllegalArgumentException
Parse a category name string into a LogCategory.

For example:

Parameters:
name - string to be parsed
Returns:
The parsed category
Throws:
java.lang.IllegalArgumentException - if the value is not valid. Known names are the categories defined by this class or created by this class with appropriate package access, or new levels defined or created by subclasses.