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 pax-logging-api Show documentation
The Pax Logging API Library is to allow for the Pax Logging Service to be reloaded without stopping the many dependent bundles. It also contains the OSGi Log Service API and the Knopflerfish Log API.
There is a newer version: 2.2.7
Show newest version
/*
 * Copyright 1999-2005 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;

/**
 * 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.
     */
    public final static Priority FATAL = new Level( FATAL_INT, "FATAL", 0 );

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

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

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

    /**
     * @deprecated Use {@link Level#DEBUG} instead.
     */
    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 level TODO
     * @param levelStr TODO
     * @param syslogEquivalent TODO
     */
    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 TODO
     */
    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.
     * @return TODO
     * @param r TODO
     */
    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 TODO
     */
    public static Priority[] getAllPossiblePriorities()
    {
        return new Priority[]{
            Priority.FATAL, Priority.ERROR, Level.WARN,
            Priority.INFO, Priority.DEBUG, Level.TRACE
        };
    }

    /**
     * Returns the string representation of this priority.
     */
    public final String toString()
    {
        return levelStr;
    }

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

    /**
     * @deprecated Please use the {@link Level#toLevel(String)} method instead.
     * @return TODO
     * @param sArg TODO
     */
    public static Priority toPriority( String sArg )
    {
        return Level.toLevel( sArg );
    }

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

    /**
     * @deprecated Please use the {@link Level#toLevel(int,Level)} method instead.
     * @return TODO
     * @param val TODO
     * @param defaultPriority TODO
     */
    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.
     * @return TODO
     * @param sArg TODO
     * @param defaultPriority TODO
     */
    public static Priority toPriority( String sArg, Priority defaultPriority )
    {
        return Level.toLevel( sArg, (Level) defaultPriority );
    }
}