org.jboss.logging.XLevel Maven / Gradle / Ivy
Show all versions of jboss-logging-log4j Show documentation
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.logging;
import org.apache.log4j.Level;
/**
* Provides custom extention levels for use with the Log4j logging framework.
*
* Adds a trace level that is below the standard Log4j DEBUG level.
*
* This is a custom level that is 100 below the {@link Level#TRACE_INT}
* and represents a lower level useful for logging events that should only
* be displayed when deep debugging is required.
*
* @see org.apache.log4j.Level
* @deprecated as log4j 1.2.14 has a native TRACE level
*
* @author Scott Stark
* @version $Revision: 2785 $
*/
public class XLevel extends Level
{
/** The serialVersionUID */
private static final long serialVersionUID = 1L;
/** The integer representation of the level, ({@link Level#TRACE_INT} - 100) */
@SuppressWarnings("hiding")
public static final int TRACE_INT = Level.TRACE_INT - 100;
/** The string name of the trace level. */
public static final String TRACE_STR = "TRACE";
/** The TRACE level object singleton */
@SuppressWarnings("hiding")
public static final XLevel TRACE = new XLevel(TRACE_INT, TRACE_STR, 7);
/**
* Construct a XLevel.
*
* @param level the level
* @param strLevel ???
* @param syslogEquiv the system log equivalent
*/
protected XLevel(final int level, final String strLevel, final int syslogEquiv)
{
super(level, strLevel, syslogEquiv);
}
/////////////////////////////////////////////////////////////////////////
// Factory Methods //
/////////////////////////////////////////////////////////////////////////
/**
* Convert an integer passed as argument to a level. If the conversion
* fails, then this method returns the specified default.
*
* @return the Level object for name if one exists, defaultLevel otherwize.
*/
public static Level toLevel(final String name, final Level defaultLevel)
{
if (name == null)
return defaultLevel;
String upper = name.toUpperCase();
if (upper.equals(TRACE_STR)) {
return TRACE;
}
return Level.toLevel(name, defaultLevel);
}
/**
* Convert an integer passed as argument to a level.
*
* @return the Level object for name if one exists
*/
public static Level toLevel(final String name)
{
return toLevel(name, TRACE);
}
/**
* Convert an integer passed as argument to a priority. If the conversion
* fails, then this method returns the specified default.
* @return the Level object for i if one exists, defaultLevel otherwize.
*/
public static Level toLevel(int i)
{
return toLevel(i, TRACE);
}
/**
* Convert an integer passed as argument to a level. If the conversion
* fails, then this method returns the specified default.
*
* @return the Level object for i if one exists, defaultLevel otherwize.
*/
public static Level toLevel(final int i, final Level defaultLevel)
{
Level p;
if (i == TRACE_INT)
p = TRACE;
else
p = Level.toLevel(i);
return p;
}
}