com.google.gwt.libideas.logging.shared
Class Level

java.lang.Object
  extended by com.google.gwt.libideas.logging.shared.Level
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable

public class Level
extends java.lang.Object
implements java.lang.Comparable, java.io.Serializable

This is a stripped-down clone of the java level class. It does not support all the functionality. The JavaDoc is imported directly from Sun. The LogImpl in use sets these fields. The logging levels are initialized by the Log class, so a method from Log must be called before the level fields are used.

See Also:
Serialized Form

Field Summary
static Level ALL
          ALL indicates that all messages should be logged.
static Level CONFIG
          CONFIG is a message level for static configuration messages.
static Level FINE
          FINE is a message level providing tracing information.
static Level FINER
          FINER indicates a fairly detailed tracing message.
static Level FINEST
          FINEST indicates a highly detailed tracing message.
static Level INFO
          INFO is a message level for informational messages.
static Level OFF
          OFF is a special level that can be used to turn off logging.
static Level SEVERE
          SEVERE is a message level indicating a serious failure.
static Level WARNING
          WARNING is a message level indicating a potential problem.
 
Constructor Summary
Level()
          Constructor used for serialization.
Level(java.lang.String name, int value)
          Create a named Level with a given integer value.
Level(java.lang.String name, int value, boolean isControl)
          Create a named Level with a given integer value.
 
Method Summary
 int compareTo(java.lang.Object o)
           
 boolean equals(java.lang.Object ox)
          Compare two objects for value equality.
 java.lang.String getName()
           
 int hashCode()
          Generate a hashcode.
 int intValue()
          Get the integer value for this level.
 boolean isControl()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OFF

public static Level OFF
OFF is a special level that can be used to turn off logging. This level is initialized to Integer.MAX_VALUE.


SEVERE

public static Level SEVERE
SEVERE is a message level indicating a serious failure.

In general SEVERE messages should describe events that are of considerable importance and which will prevent normal program execution. They should be reasonably intelligible to end users and to system administrators. This level is initialized to 1000.


WARNING

public static Level WARNING
WARNING is a message level indicating a potential problem.

In general WARNING messages should describe events that will be of interest to end users or system managers, or which indicate potential problems. This level is initialized to 900.


INFO

public static Level INFO
INFO is a message level for informational messages.

Typically INFO messages will be written to the console or its equivalent. So the INFO level should only be used for reasonably significant messages that will make sense to end users and system admins. This level is initialized to 800.


CONFIG

public static Level CONFIG
CONFIG is a message level for static configuration messages.

CONFIG messages are intended to provide a variety of static configuration information, to assist in debugging problems that may be associated with particular configurations. For example, CONFIG message might include the CPU type, the graphics depth, the GUI look-and-feel, etc. This level is initialized to 700.


FINE

public static Level FINE
FINE is a message level providing tracing information.

All of FINE, FINER, and FINEST are intended for relatively detailed tracing. The exact meaning of the three levels will vary between subsystems, but in general, FINEST should be used for the most voluminous detailed output, FINER for somewhat less detailed output, and FINE for the lowest volume (and most important) messages.

In general the FINE level should be used for information that will be broadly interesting to developers who do not have a specialized interest in the specific subsystem.

FINE messages might include things like minor (recoverable) failures. Issues indicating potential performance problems are also worth logging as FINE. This level is initialized to 500.


FINER

public static Level FINER
FINER indicates a fairly detailed tracing message. By default logging calls for entering, returning, or throwing an exception are traced at this level. This level is initialized to 400.


FINEST

public static Level FINEST
FINEST indicates a highly detailed tracing message. This level is initialized to 300.


ALL

public static Level ALL
ALL indicates that all messages should be logged. This level is initialized to Integer.MIN_VALUE.

Constructor Detail

Level

public Level()
Constructor used for serialization.


Level

public Level(java.lang.String name,
             int value)
Create a named Level with a given integer value.

Note you should always use a guarded method to create a new level.

Parameters:
name - the name of the Level, for example "SEVERE".
value - an integer value for the level.
Throws:
java.lang.NullPointerException - if the name is null

Level

public Level(java.lang.String name,
             int value,
             boolean isControl)
Create a named Level with a given integer value.

Note you should always use a guarded method to create a new level.

Parameters:
name - the name of the Level, for example "SEVERE".
value - an integer value for the level.
isControl - is a control log level, usually "ALL" or "OFF".
Throws:
java.lang.NullPointerException - if the name is null
Method Detail

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object ox)
Compare two objects for value equality.

Overrides:
equals in class java.lang.Object
Returns:
true if and only if the two objects have the same level value.

getName

public java.lang.String getName()

hashCode

public int hashCode()
Generate a hashcode.

Overrides:
hashCode in class java.lang.Object
Returns:
a hashcode based on the level value

intValue

public final int intValue()
Get the integer value for this level. This integer value can be used for efficient ordering comparisons between Level objects.

Returns:
the integer value for this level.

isControl

public boolean isControl()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object