de.ipcon.tools

Class Log4j1_ANSIColorLayout

java.lang.Object

org.apache.log4j.Layout

org.apache.log4j.PatternLayout

de.ipcon.tools.Log4j1_ANSIColorLayout

All Implemented Interfaces:

org.apache.log4j.spi.OptionHandler

public class Log4j1_ANSIColorLayout
extends org.apache.log4j.PatternLayout

Highlights Log4j messages depending on their level in the console. Replaces the PatternLayout in the log4j.properties files, e.g.

log4j.appender.stdout.layout = de.ipcon.tools.Log4j1_ANSIColorLayout

Colors are customizable. Allows usage of either explicit ANSI color texts, e.g.  for white, bold. Or a small set of constants: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET, none. Bold variants of most constants exist as well by adding "_BOLD", e.g. RED_BOLD

 log4j.appender.stdout.layout.fatal=RED_BOLD
 log4j.appender.stdout.layout.error=RED
 # explicit ANSI color codes, identical to YELLOW
 log4j.appender.stdout.layout.warn=
 # no explicit color, use default.
 log4j.appender.stdout.layout.info=none
 log4j.appender.stdout.layout.debug=
 log4j.appender.stdout.layout.reset=
 log4j.appender.stdout.layout.stacktrace=
 log4j.appender.stdout.layout.defaultcolor=
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Log4j1_ANSIColorLayout.ANSI_FG Foreground colors in ANSI, Background colors pendants start with 40.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COLOR_ALL
static java.lang.String	DEFAULT_COLOR_DEBUG
static java.lang.String	DEFAULT_COLOR_ERROR
static java.lang.String	DEFAULT_COLOR_FATAL
static java.lang.String	DEFAULT_COLOR_INFO
static java.lang.String	DEFAULT_COLOR_STACKTRACE
static java.lang.String	DEFAULT_COLOR_WARN
static java.lang.String	END_COLOR

Fields inherited from class org.apache.log4j.PatternLayout

DEFAULT_CONVERSION_PATTERN, TTCC_CONVERSION_PATTERN

Fields inherited from class org.apache.log4j.Layout

LINE_SEP, LINE_SEP_LEN

Constructor Summary

Constructors

Constructor and Description
Log4j1_ANSIColorLayout()
Log4j1_ANSIColorLayout(java.lang.String string)

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(org.apache.log4j.spi.LoggingEvent event)
java.lang.String	getAll()
java.lang.String	getDebug()
java.lang.String	getError()
java.lang.String	getFatal()
java.lang.String	getInfo()
java.lang.String	getStacktrace()
java.lang.String	getWarn()
boolean	ignoresThrowable()
void	setAll(java.lang.String inp)
void	setDebug(java.lang.String inp)
void	setDefaultColors() set the color patterns to the defaults
void	setError(java.lang.String inp)
void	setFatal(java.lang.String inp)
void	setInfo(java.lang.String inp)
void	setStacktrace(java.lang.String inp) If set, then stacktraces use this explicit color.
void	setWarn(java.lang.String inp)

Methods inherited from class org.apache.log4j.PatternLayout

activateOptions, getConversionPattern, setConversionPattern

Methods inherited from class org.apache.log4j.Layout

getContentType, getFooter, getHeader

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_COLOR_ALL

public static final java.lang.String DEFAULT_COLOR_ALL

DEFAULT_COLOR_FATAL

public static final java.lang.String DEFAULT_COLOR_FATAL

DEFAULT_COLOR_ERROR

public static final java.lang.String DEFAULT_COLOR_ERROR

DEFAULT_COLOR_WARN

public static final java.lang.String DEFAULT_COLOR_WARN

DEFAULT_COLOR_INFO

public static final java.lang.String DEFAULT_COLOR_INFO

See Also:

Constant Field Values

DEFAULT_COLOR_DEBUG

public static final java.lang.String DEFAULT_COLOR_DEBUG

DEFAULT_COLOR_STACKTRACE

public static final java.lang.String DEFAULT_COLOR_STACKTRACE

END_COLOR

public static final java.lang.String END_COLOR

See Also:

Constant Field Values

Constructor Detail

Log4j1_ANSIColorLayout

public Log4j1_ANSIColorLayout()

Log4j1_ANSIColorLayout

public Log4j1_ANSIColorLayout(java.lang.String string)

Method Detail

setDefaultColors

public void setDefaultColors()

set the color patterns to the defaults

getAll

public java.lang.String getAll()

setAll

public void setAll(java.lang.String inp)

getFatal

public java.lang.String getFatal()

setFatal

public void setFatal(java.lang.String inp)

getError

public java.lang.String getError()

setError

public void setError(java.lang.String inp)

getWarn

public java.lang.String getWarn()

setWarn

public void setWarn(java.lang.String inp)

getInfo

public java.lang.String getInfo()

setInfo

public void setInfo(java.lang.String inp)

getDebug

public java.lang.String getDebug()

setDebug

public void setDebug(java.lang.String inp)

getStacktrace

public java.lang.String getStacktrace()

setStacktrace

public void setStacktrace(java.lang.String inp)

If set, then stacktraces use this explicit color. If unset, then the default color of the loglevel is used. Default is unset

ignoresThrowable

public boolean ignoresThrowable()

Overrides:

ignoresThrowable in class org.apache.log4j.PatternLayout

format

public java.lang.String format(org.apache.log4j.spi.LoggingEvent event)

Overrides:

format in class org.apache.log4j.PatternLayout