javax.slee.facilities
Class Level

java.lang.Object
  |
  +--javax.slee.facilities.Level
All Implemented Interfaces:
java.io.Serializable

public final class Level
extends java.lang.Object
implements java.io.Serializable

This class defines an enumerated type for the alarm and trace levels supported by the Alarm Facility and Trace Facility. The class is based on the Java Logging API included with J2SE 1.4.

A singleton instance of each enumerated value is guaranteed (via an implementation of readResolve() - refer java.io.Serializable), so that equality tests using == are always evaluated correctly. (This equality test is only guaranteed if this class is loaded in the application's boot class path, rather than dynamically loaded at runtime.)

The levels in descending order are:

See Also:
Serialized Form

Field Summary
static Level CONFIG
          Level for configuration messages.
static Level FINE
          Level for basic debug messages.
static Level FINER
          Level for moderately detailed messages.
static Level FINEST
          Level for highly detailed messages.
static Level INFO
          Level for information messages.
static int LEVEL_CONFIG
          An integer representation of CONFIG.
static int LEVEL_FINE
          An integer representation of FINE.
static int LEVEL_FINER
          An integer representation of FINER.
static int LEVEL_FINEST
          An integer representation of FINEST.
static int LEVEL_INFO
          An integer representation of INFO.
static int LEVEL_OFF
          An integer representation of OFF.
static int LEVEL_SEVERE
          An integer representation of SEVERE.
static int LEVEL_WARNING
          An integer representation of WARNING.
static Level OFF
          Level for maximum filtering.
static Level SEVERE
          Level for messages indicating a severe failure.
static Level WARNING
          Level for messages indicating warning conditions.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compare this level for equality with another.
static Level fromInt(int level)
          Get an Level object from an integer value.
 int hashCode()
          Get a hash code value for this level.
 boolean isConfig()
          Determine if this Level object represents the CONFIG level.
 boolean isFine()
          Determine if this Level object represents the FINE level.
 boolean isFiner()
          Determine if this Level object represents the FINER level.
 boolean isFinest()
          Determine if this Level object represents the FINEST level.
 boolean isHigherLevel(Level other)
          Determine if this Level object represents a level that is higher or more severe that some other Level object.
 boolean isMinor()
          Determine if this Level object represents the INFO level.
 boolean isOff()
          Determine if this Level object represents the OFF level.
 boolean isSevere()
          Determine if this Level object represents the SEVERE level.
 boolean isWarning()
          Determine if this Level object represents the WARNING level.
 int toInt()
          Get an integer value representation for this Level object.
 java.lang.String toString()
          Get the textual representation of the Level object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

LEVEL_OFF

public static final int LEVEL_OFF
An integer representation of OFF.

LEVEL_SEVERE

public static final int LEVEL_SEVERE
An integer representation of SEVERE.

LEVEL_WARNING

public static final int LEVEL_WARNING
An integer representation of WARNING.

LEVEL_INFO

public static final int LEVEL_INFO
An integer representation of INFO.

LEVEL_CONFIG

public static final int LEVEL_CONFIG
An integer representation of CONFIG.

LEVEL_FINE

public static final int LEVEL_FINE
An integer representation of FINE.

LEVEL_FINER

public static final int LEVEL_FINER
An integer representation of FINER.

LEVEL_FINEST

public static final int LEVEL_FINEST
An integer representation of FINEST.

OFF

public static final Level OFF
Level for maximum filtering. Notifications cannot be generated using this level.

SEVERE

public static final Level SEVERE
Level for messages indicating a severe failure.

WARNING

public static final Level WARNING
Level for messages indicating warning conditions.

INFO

public static final Level INFO
Level for information messages.

CONFIG

public static final Level CONFIG
Level for configuration messages.

FINE

public static final Level FINE
Level for basic debug messages.

FINER

public static final Level FINER
Level for moderately detailed messages.

FINEST

public static final Level FINEST
Level for highly detailed messages. This is the lowest level.
Method Detail

fromInt

public static Level fromInt(int level)
                     throws java.lang.IllegalArgumentException
Get an Level object from an integer value.
Parameters:
level - the level as an integer.
Returns:
an Level object corresponding to level.
Throws:
java.lang.IllegalArgumentException - if level is not a valid level value.

toInt

public int toInt()
Get an integer value representation for this Level object.
Returns:
an integer value representation for this Level object.

isOff

public boolean isOff()
Determine if this Level object represents the OFF level.

This method is effectively equivalent to the conditional test: (this == OFF), ie. the code:

    if (level.isOff()) ...

is interchangeable with the code:

   if (level == Level.OFF) ...

Returns:
true if this object represents the OFF level, false otherwise.

isSevere

public boolean isSevere()
Determine if this Level object represents the SEVERE level.

This method is effectively equivalent to the conditional test: (this == SEVERE), ie. the code:

    if (level.isSevere()) ...

is interchangeable with the code:

   if (level == Level.SEVERE) ...

Returns:
true if this object represents the SEVERE level, false otherwise.

isWarning

public boolean isWarning()
Determine if this Level object represents the WARNING level.

This method is effectively equivalent to the conditional test: (this == WARNING), ie. the code:

    if (level.isWarning()) ...

is interchangeable with the code:

   if (level == Level.WARNING) ...

Returns:
true if this object represents the WARNING level, false otherwise.

isMinor

public boolean isMinor()
Determine if this Level object represents the INFO level.

This method is effectively equivalent to the conditional test: (this == INFO), ie. the code:

    if (level.isMinor()) ...

is interchangeable with the code:

   if (level == Level.INFO) ...

Returns:
true if this object represents the INFO level, false otherwise.

isConfig

public boolean isConfig()
Determine if this Level object represents the CONFIG level.

This method is effectively equivalent to the conditional test: (this == CONFIG), ie. the code:

    if (level.isConfig()) ...

is interchangeable with the code:

   if (level == Level.CONFIG) ...

Returns:
true if this object represents the CONFIG level, false otherwise.

isFine

public boolean isFine()
Determine if this Level object represents the FINE level.

This method is effectively equivalent to the conditional test: (this == FINE), ie. the code:

    if (level.isFine()) ...

is interchangeable with the code:

   if (level == Level.FINE) ...

Returns:
true if this object represents the FINE level, false otherwise.

isFiner

public boolean isFiner()
Determine if this Level object represents the FINER level.

This method is effectively equivalent to the conditional test: (this == FINER), ie. the code:

    if (level.isFiner()) ...

is interchangeable with the code:

   if (level == Level.FINER) ...

Returns:
true if this object represents the FINER level, false otherwise.

isFinest

public boolean isFinest()
Determine if this Level object represents the FINEST level.

This method is effectively equivalent to the conditional test: (this == FINEST), ie. the code:

    if (level.isFinest()) ...

is interchangeable with the code:

   if (level == Level.FINEST) ...

Returns:
true if this object represents the FINEST level, false otherwise.

isHigherLevel

public boolean isHigherLevel(Level other)
                      throws java.lang.NullPointerException
Determine if this Level object represents a level that is higher or more severe that some other Level object. For the purposes of the comparison OFF is considered a higher level than SEVERE.
Parameters:
other - the Level object to compare this with.
Returns:
true if the level represented by this Level object is a higher level than the level represented by the specified Level object, false otherwise.
Throws:
java.lang.NullPointerException - if other is null.

equals

public boolean equals(java.lang.Object obj)
Compare this level for equality with another.
Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare this with.
Returns:
true if obj is an instance of this class representing the same level as this, false otherwise.

hashCode

public int hashCode()
Get a hash code value for this level.
Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value.

toString

public java.lang.String toString()
Get the textual representation of the Level object.
Overrides:
toString in class java.lang.Object
Returns:
the textual representation of the Level object.