0N/A/*
4102N/A * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage java.util.logging;
0N/Aimport java.util.ArrayList;
0N/Aimport java.util.HashMap;
0N/Aimport java.util.List;
0N/Aimport java.util.Map;
0N/Aimport java.util.ResourceBundle;
0N/A
4102N/A/**
0N/A * The Level class defines a set of standard logging levels that
0N/A * can be used to control logging output. The logging Level objects
0N/A * are ordered and are specified by ordered integers. Enabling logging
0N/A * at a given level also enables logging at all higher levels.
0N/A * <p>
4102N/A * Clients should normally use the predefined Level constants such
0N/A * as Level.SEVERE.
4102N/A * <p>
0N/A * The levels in descending order are:
0N/A * <ul>
0N/A * <li>SEVERE (highest value)
0N/A * <li>WARNING
0N/A * <li>INFO
0N/A * <li>CONFIG
0N/A * <li>FINE
0N/A * <li>FINER
0N/A * <li>FINEST (lowest value)
0N/A * </ul>
0N/A * In addition there is a level OFF that can be used to turn
0N/A * off logging, and a level ALL that can be used to enable
0N/A * logging of all messages.
0N/A * <p>
0N/A * It is possible for third parties to define additional logging
0N/A * levels by subclassing Level. In such cases subclasses should
0N/A * take care to chose unique integer level values and to ensure that
0N/A * they maintain the Object uniqueness property across serialization
0N/A * by defining a suitable readResolve method.
0N/A *
0N/A * @since 1.4
0N/A */
0N/A
0N/Apublic class Level implements java.io.Serializable {
0N/A private static String defaultBundle = "sun.util.logging.resources.logging";
0N/A
0N/A /**
0N/A * @serial The non-localized name of the level.
0N/A */
0N/A private final String name;
0N/A
0N/A /**
0N/A * @serial The integer value of the level.
0N/A */
0N/A private final int value;
0N/A
0N/A /**
0N/A * @serial The resource bundle name to be used in localizing the level name.
0N/A */
0N/A private final String resourceBundleName;
0N/A
0N/A // localized level name
0N/A private String localizedLevelName;
0N/A
0N/A /**
0N/A * OFF is a special level that can be used to turn off logging.
0N/A * This level is initialized to <CODE>Integer.MAX_VALUE</CODE>.
0N/A */
0N/A public static final Level OFF = new Level("OFF",Integer.MAX_VALUE, defaultBundle);
0N/A
0N/A /**
0N/A * SEVERE is a message level indicating a serious failure.
0N/A * <p>
0N/A * In general SEVERE messages should describe events that are
0N/A * of considerable importance and which will prevent normal
0N/A * program execution. They should be reasonably intelligible
0N/A * to end users and to system administrators.
0N/A * This level is initialized to <CODE>1000</CODE>.
0N/A */
0N/A public static final Level SEVERE = new Level("SEVERE",1000, defaultBundle);
0N/A
0N/A /**
0N/A * WARNING is a message level indicating a potential problem.
0N/A * <p>
0N/A * In general WARNING messages should describe events that will
0N/A * be of interest to end users or system managers, or which
0N/A * indicate potential problems.
0N/A * This level is initialized to <CODE>900</CODE>.
0N/A */
0N/A public static final Level WARNING = new Level("WARNING", 900, defaultBundle);
0N/A
0N/A /**
0N/A * INFO is a message level for informational messages.
0N/A * <p>
0N/A * Typically INFO messages will be written to the console
0N/A * or its equivalent. So the INFO level should only be
0N/A * used for reasonably significant messages that will
0N/A * make sense to end users and system administrators.
0N/A * This level is initialized to <CODE>800</CODE>.
0N/A */
0N/A public static final Level INFO = new Level("INFO", 800, defaultBundle);
0N/A
0N/A /**
0N/A * CONFIG is a message level for static configuration messages.
0N/A * <p>
0N/A * CONFIG messages are intended to provide a variety of static
0N/A * configuration information, to assist in debugging problems
0N/A * that may be associated with particular configurations.
0N/A * For example, CONFIG message might include the CPU type,
0N/A * the graphics depth, the GUI look-and-feel, etc.
0N/A * This level is initialized to <CODE>700</CODE>.
0N/A */
0N/A public static final Level CONFIG = new Level("CONFIG", 700, defaultBundle);
0N/A
0N/A /**
0N/A * FINE is a message level providing tracing information.
0N/A * <p>
0N/A * All of FINE, FINER, and FINEST are intended for relatively
0N/A * detailed tracing. The exact meaning of the three levels will
0N/A * vary between subsystems, but in general, FINEST should be used
0N/A * for the most voluminous detailed output, FINER for somewhat
0N/A * less detailed output, and FINE for the lowest volume (and
0N/A * most important) messages.
0N/A * <p>
0N/A * In general the FINE level should be used for information
0N/A * that will be broadly interesting to developers who do not have
0N/A * a specialized interest in the specific subsystem.
0N/A * <p>
0N/A * FINE messages might include things like minor (recoverable)
0N/A * failures. Issues indicating potential performance problems
0N/A * are also worth logging as FINE.
0N/A * This level is initialized to <CODE>500</CODE>.
3054N/A */
0N/A public static final Level FINE = new Level("FINE", 500, defaultBundle);
0N/A
0N/A /**
0N/A * FINER indicates a fairly detailed tracing message.
0N/A * By default logging calls for entering, returning, or throwing
0N/A * an exception are traced at this level.
0N/A * This level is initialized to <CODE>400</CODE>.
0N/A */
0N/A public static final Level FINER = new Level("FINER", 400, defaultBundle);
0N/A
0N/A /**
0N/A * FINEST indicates a highly detailed tracing message.
0N/A * This level is initialized to <CODE>300</CODE>.
0N/A */
0N/A public static final Level FINEST = new Level("FINEST", 300, defaultBundle);
0N/A
0N/A /**
0N/A * ALL indicates that all messages should be logged.
0N/A * This level is initialized to <CODE>Integer.MIN_VALUE</CODE>.
3054N/A */
0N/A public static final Level ALL = new Level("ALL", Integer.MIN_VALUE, defaultBundle);
0N/A
0N/A /**
0N/A * Create a named Level with a given integer value.
0N/A * <p>
0N/A * Note that this constructor is "protected" to allow subclassing.
0N/A * In general clients of logging should use one of the constant Level
0N/A * objects such as SEVERE or FINEST. However, if clients need to
0N/A * add new logging levels, they may subclass Level and define new
0N/A * constants.
0N/A * @param name the name of the Level, for example "SEVERE".
0N/A * @param value an integer value for the level.
0N/A * @throws NullPointerException if the name is null
0N/A */
0N/A protected Level(String name, int value) {
0N/A this(name, value, null);
4102N/A }
4102N/A
4102N/A /**
0N/A * Create a named Level with a given integer value and a
0N/A * given localization resource name.
0N/A * <p>
0N/A * @param name the name of the Level, for example "SEVERE".
0N/A * @param value an integer value for the level.
3054N/A * @param resourceBundleName name of a resource bundle to use in
0N/A * localizing the given name. If the resourceBundleName is null
0N/A * or an empty string, it is ignored.
0N/A * @throws NullPointerException if the name is null
0N/A */
0N/A protected Level(String name, int value, String resourceBundleName) {
0N/A if (name == null) {
0N/A throw new NullPointerException();
0N/A }
0N/A this.name = name;
0N/A this.value = value;
0N/A this.resourceBundleName = resourceBundleName;
0N/A this.localizedLevelName = resourceBundleName == null ? name : null;
3054N/A KnownLevel.add(this);
0N/A }
0N/A
0N/A /**
0N/A * Return the level's localization resource bundle name, or
0N/A * null if no localization bundle is defined.
3054N/A *
3054N/A * @return localization resource bundle name
0N/A */
3054N/A public String getResourceBundleName() {
0N/A return resourceBundleName;
0N/A }
3054N/A
3054N/A /**
3054N/A * Return the non-localized string name of the Level.
0N/A *
0N/A * @return non-localized name
0N/A */
0N/A public String getName() {
0N/A return name;
0N/A }
0N/A
0N/A /**
0N/A * Return the localized string name of the Level, for
0N/A * the current default locale.
0N/A * <p>
0N/A * If no localization information is available, the
0N/A * non-localized name is returned.
0N/A *
0N/A * @return localized name
0N/A */
0N/A public String getLocalizedName() {
0N/A return getLocalizedLevelName();
0N/A }
0N/A
0N/A // package-private getLevelName() is used by the implementation
0N/A // instead of getName() to avoid calling the subclass's version
0N/A final String getLevelName() {
0N/A return this.name;
0N/A }
0N/A
0N/A final synchronized String getLocalizedLevelName() {
0N/A if (localizedLevelName != null) {
0N/A return localizedLevelName;
0N/A }
0N/A
0N/A try {
0N/A ResourceBundle rb = ResourceBundle.getBundle(resourceBundleName);
0N/A localizedLevelName = rb.getString(name);
0N/A } catch (Exception ex) {
0N/A localizedLevelName = name;
0N/A }
return localizedLevelName;
}
// Returns a mirrored Level object that matches the given name as
// specified in the Level.parse method. Returns null if not found.
//
// It returns the same Level object as the one returned by Level.parse
// method if the given name is a non-localized name or integer.
//
// If the name is a localized name, findLevel and parse method may
// return a different level value if there is a custom Level subclass
// that overrides Level.getLocalizedName() to return a different string
// than what's returned by the default implementation.
//
static Level findLevel(String name) {
if (name == null) {
throw new NullPointerException();
}
KnownLevel level;
// Look for a known Level with the given non-localized name.
level = KnownLevel.findByName(name);
if (level != null) {
return level.mirroredLevel;
}
// Now, check if the given name is an integer. If so,
// first look for a Level with the given value and then
// if necessary create one.
try {
int x = Integer.parseInt(name);
level = KnownLevel.findByValue(x);
if (level == null) {
// add new Level
Level levelObject = new Level(name, x);
level = KnownLevel.findByValue(x);
}
return level.mirroredLevel;
} catch (NumberFormatException ex) {
// Not an integer.
// Drop through.
}
level = KnownLevel.findByLocalizedLevelName(name);
if (level != null) {
return level.mirroredLevel;
}
return null;
}
/**
* Returns a string representation of this Level.
*
* @return the non-localized name of the Level, for example "INFO".
*/
public final String toString() {
return name;
}
/**
* Get the integer value for this level. This integer value
* can be used for efficient ordering comparisons between
* Level objects.
* @return the integer value for this level.
*/
public final int intValue() {
return value;
}
private static final long serialVersionUID = -8176160795706313070L;
// Serialization magic to prevent "doppelgangers".
// This is a performance optimization.
private Object readResolve() {
KnownLevel o = KnownLevel.matches(this);
if (o != null) {
return o.levelObject;
}
// Woops. Whoever sent us this object knows
// about a new log level. Add it to our list.
Level level = new Level(this.name, this.value, this.resourceBundleName);
return level;
}
/**
* Parse a level name string into a Level.
* <p>
* The argument string may consist of either a level name
* or an integer value.
* <p>
* For example:
* <ul>
* <li> "SEVERE"
* <li> "1000"
* </ul>
*
* @param name string to be parsed
* @throws NullPointerException if the name is null
* @throws IllegalArgumentException if the value is not valid.
* Valid values are integers between <CODE>Integer.MIN_VALUE</CODE>
* and <CODE>Integer.MAX_VALUE</CODE>, and all known level names.
* Known names are the levels defined by this class (e.g., <CODE>FINE</CODE>,
* <CODE>FINER</CODE>, <CODE>FINEST</CODE>), or created by this class with
* appropriate package access, or new levels defined or created
* by subclasses.
*
* @return The parsed value. Passing an integer that corresponds to a known name
* (e.g., 700) will return the associated name (e.g., <CODE>CONFIG</CODE>).
* Passing an integer that does not (e.g., 1) will return a new level name
* initialized to that value.
*/
public static synchronized Level parse(String name) throws IllegalArgumentException {
// Check that name is not null.
name.length();
KnownLevel level;
// Look for a known Level with the given non-localized name.
level = KnownLevel.findByName(name);
if (level != null) {
return level.levelObject;
}
// Now, check if the given name is an integer. If so,
// first look for a Level with the given value and then
// if necessary create one.
try {
int x = Integer.parseInt(name);
level = KnownLevel.findByValue(x);
if (level == null) {
// add new Level
Level levelObject = new Level(name, x);
level = KnownLevel.findByValue(x);
}
return level.levelObject;
} catch (NumberFormatException ex) {
// Not an integer.
// Drop through.
}
// Finally, look for a known level with the given localized name,
// in the current default locale.
// This is relatively expensive, but not excessively so.
level = KnownLevel.findByLocalizedName(name);
if (level != null) {
return level.levelObject;
}
// OK, we've tried everything and failed
throw new IllegalArgumentException("Bad level \"" + name + "\"");
}
/**
* Compare two objects for value equality.
* @return true if and only if the two objects have the same level value.
*/
public boolean equals(Object ox) {
try {
Level lx = (Level)ox;
return (lx.value == this.value);
} catch (Exception ex) {
return false;
}
}
/**
* Generate a hashcode.
* @return a hashcode based on the level value
*/
public int hashCode() {
return this.value;
}
// KnownLevel class maintains the global list of all known levels.
// The API allows multiple custom Level instances of the same name/value
// be created. This class provides convenient methods to find a level
// by a given name, by a given value, or by a given localized name.
//
// KnownLevel wraps the following Level objects:
// 1. levelObject: standard Level object or custom Level object
// 2. mirroredLevel: Level object representing the level specified in the
// logging configuration.
//
// Level.getName, Level.getLocalizedName, Level.getResourceBundleName methods
// are non-final but the name and resource bundle name are parameters to
// the Level constructor. Use the mirroredLevel object instead of the
// levelObject to prevent the logging framework to execute foreign code
// implemented by untrusted Level subclass.
//
// Implementation Notes:
// If Level.getName, Level.getLocalizedName, Level.getResourceBundleName methods
// were final, the following KnownLevel implementation can be removed.
// Future API change should take this into consideration.
static final class KnownLevel {
private static Map<String, List<KnownLevel>> nameToLevels = new HashMap<>();
private static Map<Integer, List<KnownLevel>> intToLevels = new HashMap<>();
final Level levelObject; // instance of Level class or Level subclass
final Level mirroredLevel; // instance of Level class
KnownLevel(Level l) {
this.levelObject = l;
if (l.getClass() == Level.class) {
this.mirroredLevel = l;
} else {
this.mirroredLevel = new Level(l.name, l.value, l.resourceBundleName);
}
}
static synchronized void add(Level l) {
// the mirroredLevel object is always added to the list
// before the custom Level instance
KnownLevel o = new KnownLevel(l);
List<KnownLevel> list = nameToLevels.get(l.name);
if (list == null) {
list = new ArrayList<>();
nameToLevels.put(l.name, list);
}
list.add(o);
list = intToLevels.get(l.value);
if (list == null) {
list = new ArrayList<>();
intToLevels.put(l.value, list);
}
list.add(o);
}
// Returns a KnownLevel with the given non-localized name.
static synchronized KnownLevel findByName(String name) {
List<KnownLevel> list = nameToLevels.get(name);
if (list != null) {
return list.get(0);
}
return null;
}
// Returns a KnownLevel with the given value.
static synchronized KnownLevel findByValue(int value) {
List<KnownLevel> list = intToLevels.get(value);
if (list != null) {
return list.get(0);
}
return null;
}
// Returns a KnownLevel with the given localized name matching
// by calling the Level.getLocalizedLevelName() method (i.e. found
// from the resourceBundle associated with the Level object).
// This method does not call Level.getLocalizedName() that may
// be overridden in a subclass implementation
static synchronized KnownLevel findByLocalizedLevelName(String name) {
for (List<KnownLevel> levels : nameToLevels.values()) {
for (KnownLevel l : levels) {
String lname = l.levelObject.getLocalizedLevelName();
if (name.equals(lname)) {
return l;
}
}
}
return null;
}
// Returns a KnownLevel with the given localized name matching
// by calling the Level.getLocalizedName() method
static synchronized KnownLevel findByLocalizedName(String name) {
for (List<KnownLevel> levels : nameToLevels.values()) {
for (KnownLevel l : levels) {
String lname = l.levelObject.getLocalizedName();
if (name.equals(lname)) {
return l;
}
}
}
return null;
}
static synchronized KnownLevel matches(Level l) {
List<KnownLevel> list = nameToLevels.get(l.name);
if (list != null) {
for (KnownLevel level : list) {
Level other = level.mirroredLevel;
if (l.value == other.value &&
(l.resourceBundleName == other.resourceBundleName ||
(l.resourceBundleName != null &&
l.resourceBundleName.equals(other.resourceBundleName)))) {
return level;
}
}
}
return null;
}
}
}