Module ch.qos.logback.core

Package ch.qos.logback.core

Class ConsoleAppender<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.UnsynchronizedAppenderBase<E>

ch.qos.logback.core.OutputStreamAppender<E>

ch.qos.logback.core.ConsoleAppender<E>

All Implemented Interfaces:

Appender<E>, ContextAware, FilterAttachable<E>, LifeCycle

public class ConsoleAppender<E>
extends OutputStreamAppender<E>

ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. The default target is System.out.

For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#ConsoleAppender

Author:

Ceki Gülcü, Tom SH Liu, Ruediger Dohna

Field Summary

Fields

Modifier and Type	Field	Description
protected ConsoleTarget	target
protected boolean	withJansi

Fields inherited from class ch.qos.logback.core.OutputStreamAppender

encoder, streamWriteLock

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
ConsoleAppender()

Method Summary

Modifier and Type	Method	Description
protected ReentryGuard	buildReentryGuard()	Create a ThreadLocal ReentryGuard to prevent recursive appender invocations.
String	getTarget()	Returns the current value of the target property.
boolean	isWithJansi()
void	setTarget(String value)	Sets the value of the Target option.
void	setWithJansi(boolean withJansi)	If true, this appender will output to a stream provided by the JANSI library.
void	start()	Checks that requires parameters are set and if everything is in order, activates this appender.

Methods inherited from class ch.qos.logback.core.OutputStreamAppender

append, closeOutputStream, getEncoder, getOutputStream, isImmediateFlush, setEncoder, setImmediateFlush, setLayout, setOutputStream, stop, subAppend, updateByteCount, writeByteArrayToOutputStreamWithPossibleFlush, writeOut

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

target

protected ConsoleTarget target

withJansi

protected boolean withJansi

Constructor Detail

ConsoleAppender

public ConsoleAppender()

Method Detail

setTarget

public void setTarget(String value)

Sets the value of the Target option. Recognized values are "System.out" and "System.err". Any other value will be ignored.

getTarget

public String getTarget()

Returns the current value of the target property. The default value of the option is "System.out".

See also setTarget(java.lang.String).

start

public void start()

Description copied from class: OutputStreamAppender

Checks that requires parameters are set and if everything is in order, activates this appender.

Specified by:

start in interface LifeCycle

Overrides:

start in class OutputStreamAppender<E>

buildReentryGuard

protected ReentryGuard buildReentryGuard()

Create a ThreadLocal ReentryGuard to prevent recursive appender invocations.

Overrides:

buildReentryGuard in class UnsynchronizedAppenderBase<E>

Returns:

a ReentryGuard instance of type THREAD_LOCAL.

isWithJansi

public boolean isWithJansi()

Returns:

whether to use JANSI or not.

setWithJansi

public void setWithJansi(boolean withJansi)

If true, this appender will output to a stream provided by the JANSI library.

Parameters:

withJansi - whether to use JANSI or not.

Since:

1.0.5