|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.logging.Level
public class Level
The Level class defines a set of standard logging levels that can be used to control logging output. The logging Level objects are ordered and are specified by ordered integers. Enabling logging at a given level also enables logging at all higher levels.
Clients should normally use the predefined Level constants such as Level.SEVERE.
The levels in descending order are:
It is possible for third parties to define additional logging levels by subclassing Level. In such cases subclasses should take care to chose unique integer level values and to ensure that they maintain the Object uniqueness property across serialization by defining a suitable readResolve method.
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 | |
---|---|
protected |
Level(String name,
int value)
Create a named Level with a given integer value. |
protected |
Level(String name,
int value,
String resourceBundleName)
Create a named Level with a given integer value and a given localization resource name. |
Method Summary | |
---|---|
boolean |
equals(Object ox)
Compare two objects for value equality. |
String |
getLocalizedName()
Return the localized string name of the Level, for the current default locale. |
String |
getName()
Return the non-localized string name of the Level. |
String |
getResourceBundleName()
Return the level's localization resource bundle name, or null if no localization bundle is defined. |
int |
hashCode()
Generate a hashcode. |
int |
intValue()
Get the integer value for this level. |
static Level |
parse(String name)
Parse a level name string into a Level. |
String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Level OFF
Integer.MAX_VALUE
.
public static final Level SEVERE
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
.
public static final Level WARNING
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
.
public static final Level INFO
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
.
public static final Level CONFIG
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
.
public static final Level FINE
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
.
public static final Level FINER
400
.
public static final Level FINEST
300
.
public static final Level ALL
Integer.MIN_VALUE
.
Constructor Detail |
---|
protected Level(String name, int value)
Note that this constructor is "protected" to allow subclassing. In general clients of logging should use one of the constant Level objects such as SEVERE or FINEST. However, if clients need to add new logging levels, they may subclass Level and define new constants.
name
- the name of the Level, for example "SEVERE".value
- an integer value for the level.
NullPointerException
- if the name is nullprotected Level(String name, int value, String resourceBundleName)
name
- the name of the Level, for example "SEVERE".value
- an integer value for the level.resourceBundleName
- name of a resource bundle to use in
localizing the given name. If the resourceBundleName is null
or an empty string, it is ignored.
NullPointerException
- if the name is nullMethod Detail |
---|
public String getResourceBundleName()
public String getName()
public String getLocalizedName()
If no localization information is available, the non-localized name is returned.
public final String toString()
Object
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
toString
in class Object
public final int intValue()
public static Level parse(String name) throws IllegalArgumentException
The argument string may consist of either a level name or an integer value.
For example:
name
- string to be parsed
CONFIG
).
Passing an integer that does not (eg 1) will return a new level name
initialized to that value.
NullPointerException
- if the name is null
IllegalArgumentException
- if the value is not valid.
Valid values are integers between Integer.MIN_VALUE
and Integer.MAX_VALUE
, and all known level names.
Known names are the levels defined by this class (i.e. FINE
,
FINER
, FINEST
), or created by this class with
appropriate package access, or new levels defined or created
by subclasses.public boolean equals(Object ox)
equals
in class Object
ox
- the reference object with which to compare.
Object.hashCode()
,
Hashtable
public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
Hashtable
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.