org.apache.log4j.Priority Maven / Gradle / Ivy
Show all versions of log4j-over-slf4j Show documentation
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Contributors: Kitching Simon
package org.apache.log4j;
// Contributors: Kitching Simon
/**
Refrain from using this class directly, use
the {@link Level} class instead.
@author Ceki Gülcü */
public class Priority {
transient int level;
transient String levelStr;
transient int syslogEquivalent;
public final static int OFF_INT = Integer.MAX_VALUE;
public final static int FATAL_INT = 50000;
public final static int ERROR_INT = 40000;
public final static int WARN_INT = 30000;
public final static int INFO_INT = 20000;
public final static int DEBUG_INT = 10000;
// public final static int FINE_INT = DEBUG_INT;
public final static int ALL_INT = Integer.MIN_VALUE;
/**
* @deprecated Use {@link Level#FATAL} instead.
*/
final static public Priority FATAL = new Level(FATAL_INT, "FATAL", 0);
/**
* @deprecated Use {@link Level#ERROR} instead.
*/
@Deprecated
final static public Priority ERROR = new Level(ERROR_INT, "ERROR", 3);
/**
* @deprecated Use {@link Level#WARN} instead.
*/
@Deprecated
final static public Priority WARN = new Level(WARN_INT, "WARN", 4);
/**
* @deprecated Use {@link Level#INFO} instead.
*/
@Deprecated
final static public Priority INFO = new Level(INFO_INT, "INFO", 6);
/**
* @deprecated Use {@link Level#DEBUG} instead.
*/
@Deprecated
final static public Priority DEBUG = new Level(DEBUG_INT, "DEBUG", 7);
/**
* Default constructor for deserialization.
*/
protected Priority() {
level = DEBUG_INT;
levelStr = "DEBUG";
syslogEquivalent = 7;
}
/**
Instantiate a level object.
@param
*/
/**
* Instantiate a level object.
*
* @param level a level as in int
* @param levelStr a levelStr
* @param syslogEquivalent the syslog equivalent level integer
*/
protected Priority(int level, String levelStr, int syslogEquivalent) {
this.level = level;
this.levelStr = levelStr;
this.syslogEquivalent = syslogEquivalent;
}
/**
Two priorities are equal if their level fields are equal.
@since 1.2
*/
public boolean equals(Object o) {
if (o instanceof Priority) {
Priority r = (Priority) o;
return (this.level == r.level);
} else {
return false;
}
}
/**
Return the syslog equivalent of this priority as an integer.
@return the Syslog Equivalent of this Priority
*/
public final int getSyslogEquivalent() {
return syslogEquivalent;
}
/**
* Returns true if this level has a higher or equal
* level than the level passed as argument, false
* otherwise.
*
* You should think twice before overriding the default
* implementation of isGreaterOrEqual method.
*
* @param r a priority
* @return a boolean
*/
public boolean isGreaterOrEqual(Priority r) {
return level >= r.level;
}
/**
Return all possible priorities as an array of Level objects in
descending order.
@deprecated This method will be removed with no replacement.
@return array of all possible priorities
*/
@Deprecated
public static Priority[] getAllPossiblePriorities() {
return new Priority[] { Priority.FATAL, Priority.ERROR, Level.WARN, Priority.INFO, Priority.DEBUG };
}
/**
Returns the string representation of this priority.
*/
final public String toString() {
return levelStr;
}
/**
* Returns the integer representation of this level.
*
* @return integer representation of this level
*/
public final int toInt() {
return level;
}
/**
* @deprecated Please use the {@link Level#toLevel(String)} method instead.
*
* @param sArg a string to convert to a Priority
* @return the corresponding Priority
*/
@Deprecated
public static Priority toPriority(String sArg) {
return Level.toLevel(sArg);
}
/**
* @deprecated Please use the {@link Level#toLevel(int)} method instead.
*
* @param val an integer to convert to a Priority
* @return the corresponding Priority
*/
@Deprecated
public static Priority toPriority(int val) {
return toPriority(val, Priority.DEBUG);
}
/**
* @deprecated Please use the {@link Level#toLevel(int, Level)} method instead.
*
* @param val an integer value
* @param defaultPriority a default priority value
* @return correspoding Priority value
*/
@Deprecated
public static Priority toPriority(int val, Priority defaultPriority) {
return Level.toLevel(val, (Level) defaultPriority);
}
/**
* @deprecated Please use the {@link Level#toLevel(String, Level)} method instead.
* @param sArg string value
* @param defaultPriority a default Priority
* @return a Priority
*/
@Deprecated
public static Priority toPriority(String sArg, Priority defaultPriority) {
return Level.toLevel(sArg, (Level) defaultPriority);
}
}