org.apache.log4j.Priority Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of log4j1.2-api Show documentation
Apache Log4j 1.2 compatible logging API
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

package org.apache.log4j;

/**
 * Refrain from using this class directly, use the {@link Level} class instead.
 */
public class Priority {

	/**
	 * The {@code OFF} has the highest possible rank and is intended to turn off logging.
	 */
	public static final int OFF_INT = Integer.MAX_VALUE;
	/**
	 * The {@code FATAL} level designates very severe error events that will presumably lead the application to abort.
	 */
	public static final int FATAL_INT = 50000;
	/**
	 * The {@code ERROR} level designates error events that might still allow the application to continue running.
	 */
	public static final int ERROR_INT = 40000;
	/**
	 * The {@code WARN} level designates potentially harmful situations.
	 */
	public static final int WARN_INT = 30000;
	/**
	 * The {@code INFO} level designates informational messages that highlight the progress of the application at
	 * coarse-grained level.
	 */
	public static final int INFO_INT = 20000;
	/**
	 * The {@code DEBUG} Level designates fine-grained informational events that are most useful to debug an
	 * application.
	 */
	public static final int DEBUG_INT = 10000;
	// public final static int FINE_INT = DEBUG_INT;
	/**
	 * The {@code ALL} has the lowest possible rank and is intended to turn on all logging.
	 */
	public static final int ALL_INT = Integer.MIN_VALUE;

	/**
	 * @deprecated Use {@link Level#FATAL} instead.
	 */
	@Deprecated
	public static final Priority FATAL = new Level(FATAL_INT, "FATAL", 0);

	/**
	 * @deprecated Use {@link Level#ERROR} instead.
	 */
	@Deprecated
	public static final Priority ERROR = new Level(ERROR_INT, "ERROR", 3);

	/**
	 * @deprecated Use {@link Level#WARN} instead.
	 */
	@Deprecated
	public static final Priority WARN = new Level(WARN_INT, "WARN", 4);

	/**
	 * @deprecated Use {@link Level#INFO} instead.
	 */
	@Deprecated
	public static final Priority INFO = new Level(INFO_INT, "INFO", 6);

	/**
	 * @deprecated Use {@link Level#DEBUG} instead.
	 */
	@Deprecated
	public static final Priority DEBUG = new Level(DEBUG_INT, "DEBUG", 7);

	/*
	 * These variables should be private but were not in Log4j 1.2 so are left the same way here.
	 */
	// @checkstyle off: VisibilityModifier
	transient int level;
	transient String levelStr;
	transient int syslogEquivalent;
	// @checkstyle on: VisibilityModifier

	/**
	 * Default constructor for deserialization.
	 */
	protected Priority() {
		level = DEBUG.level;
		levelStr = DEBUG.levelStr;
		syslogEquivalent = DEBUG.syslogEquivalent;
	}

	/**
	 * Instantiate a level object.
	 * 
	 * @param level
	 *            The level value.
	 * @param levelStr
	 *            The level name.
	 * @param syslogEquivalent
	 *            The equivalent syslog value.
	 */
	protected Priority(final int level, final String levelStr, final int syslogEquivalent) {
		this.level = level;
		this.levelStr = levelStr;
		this.syslogEquivalent = syslogEquivalent;
	}

	/**
	 * Two priorities are equal if their level fields are equal.
	 * 
	 * @param o
	 *            The Object to check.
	 * @return true if the objects are equal, false otherwise.
	 *
	 * @since 1.2
	 */
	@Override
	public boolean equals(final Object o) {
		if (o instanceof Priority) {
			final Priority r = (Priority) o;
			return this.level == r.level;
		}
		return false;
	}

	@Override
	public int hashCode() {
		return this.level;
	}

	/**
	 * Returns the syslog equivalent of this priority as an integer.
	 * 
	 * @return The equivalent syslog value.
	 */
	public final int getSyslogEquivalent() {
		return syslogEquivalent;
	}

	/**
	 * Returns {@code true} if this level has a higher or equal level than the level passed as argument, {@code false}
	 * otherwise.
	 * 
	 * You should think twice before overriding the default implementation of {@code isGreaterOrEqual} method.
	 * 
	 * 
	 * @param r
	 *            The Priority to check.
	 * @return true if the current level is greater or equal to the specified Priority.
	 */
	public boolean isGreaterOrEqual(final Priority r) {
		return level >= r.level;
	}

	/**
	 * Returns all possible priorities as an array of Level objects in descending order.
	 * 
	 * @return An array of all possible Priorities.
	 *
	 * @deprecated This method will be removed with no replacement.
	 */
	@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.
	 * 
	 * @return The name of the Priority.
	 */
	@Override
	public final String toString() {
		return levelStr;
	}

	/**
	 * Returns the integer representation of this level.
	 * 
	 * @return The integer value of this level.
	 */
	public final int toInt() {
		return level;
	}

	/**
	 * @param sArg
	 *            The name of the Priority.
	 * @return The Priority matching the name.
	 * @deprecated Please use the {@link Level#toLevel(String)} method instead.
	 */
	@Deprecated
	public static Priority toPriority(final String sArg) {
		return Level.toLevel(sArg);
	}

	/**
	 * @param val
	 *            The value of the Priority.
	 * @return The Priority matching the value.
	 * @deprecated Please use the {@link Level#toLevel(int)} method instead.
	 */
	@Deprecated
	public static Priority toPriority(final int val) {
		return toPriority(val, Priority.DEBUG);
	}

	/**
	 * @param val
	 *            The value of the Priority.
	 * @param defaultPriority
	 *            The default Priority to use if the value is invalid.
	 * @return The Priority matching the value or the default Priority if no match is found.
	 * @deprecated Please use the {@link Level#toLevel(int, Level)} method instead.
	 */
	@Deprecated
	public static Priority toPriority(final int val, final Priority defaultPriority) {
		return Level.toLevel(val, (Level) defaultPriority);
	}

	/**
	 * @param sArg
	 *            The name of the Priority.
	 * @param defaultPriority
	 *            The default Priority to use if the name is not found.
	 * @return The Priority matching the name or the default Priority if no match is found.
	 * @deprecated Please use the {@link Level#toLevel(String, Level)} method instead.
	 */
	@Deprecated
	public static Priority toPriority(final String sArg, final Priority defaultPriority) {
		return Level.toLevel(sArg, (Level) defaultPriority);
	}
}