Class JansiConsoleAppender<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>

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

Type Parameters:

E - the type of logging events

All Implemented Interfaces:

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

public class JansiConsoleAppender<E>
extends ConsoleAppender<E>

A ConsoleAppender that always writes through JLine's AnsiConsole, enabling ANSI sequences on platforms that need Jansi (notably Windows).

Unlike ConsoleAppender's deprecated withJansi path, this class overrides wrapTarget(OutputStream) and calls AnsiConsole directly (no reflection). It requires org.jline:jansi-core on the classpath.

AnsiConsole.systemInstall() is paired with AnsiConsole.systemUninstall() on stop() when this appender performed the install. Console streams are still only flushed on stop (not closed); see ConsoleAppender.closeOutputStream().

Since:

1.6.3

Author:

Ceki Gülcü

See Also:

• AnsiConsole
• ConsoleAppender.wrapTarget(OutputStream)

Field Summary

Fields inherited from class ConsoleAppender

FUSESOURCE_JANSI_ANSI_CONSOLE_CLASS_NAME, preferredJansiClassName, target, withJansi

Fields inherited from class OutputStreamAppender

encoder, streamWriteLock

Fields inherited from class UnsynchronizedAppenderBase

name, started

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
JansiConsoleAppender()

Method Summary

Modifier and Type	Method	Description
void	stop()	Flushes the console stream (via OutputStreamAppender.stop()), then undoes AnsiConsole.systemInstall() if this appender performed it.
protected OutputStream	wrapTarget(OutputStream targetStream)	Installs Jansi and returns AnsiConsole.out() or AnsiConsole.err() according to the configured target.

Methods inherited from class ConsoleAppender

buildReentryGuard, closeOutputStream, getPreferredJansiClassName, getTarget, isWithJansi, setPreferredJansiClassName, setTarget, setWithJansi, start, wrapWithJansi

Methods inherited from class OutputStreamAppender

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

Methods inherited from class UnsynchronizedAppenderBase

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

Methods inherited from class ContextAwareBase

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

Methods inherited from class Object

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

Methods inherited from interface ContextAware

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

Constructor Details

JansiConsoleAppender

public JansiConsoleAppender()

Method Details

stop

public void stop()

Flushes the console stream (via OutputStreamAppender.stop()), then undoes AnsiConsole.systemInstall() if this appender performed it.

Specified by:

stop in interface LifeCycle

Overrides:

stop in class OutputStreamAppender<E>

wrapTarget

protected OutputStream wrapTarget(OutputStream targetStream)

Installs Jansi and returns AnsiConsole.out() or AnsiConsole.err() according to the configured target.

Does not use the deprecated withJansi / wrapWithJansi path. AnsiConsole.systemInstall() is invoked at most once per install ownership of this instance.

If JLINE_JANSI_ANSI_CONSOLE_CLASS_NAME is not loadable, a warning is emitted and targetStream is returned unchanged.

Overrides:

wrapTarget in class ConsoleAppender<E>

Parameters:

targetStream - the raw stream for ConsoleAppender.target

Returns:

the stream to use as this appender's output stream