Modifier and Type	Class and Description
private static class	ConsoleHandler.ConsoleHolder
public static enum	ConsoleHandler.Target The target stream type.

Modifier and Type	Field and Description
private static final OutputStream	err
private static final String	ESC
private final ErrorManager	localErrorManager
private static final OutputStream	out

Access	Constructor and Description
public	ConsoleHandler() Construct a new instance.
public	ConsoleHandler(final Formatter the formatter to use formatter) Construct a new instance.
public	ConsoleHandler(final ConsoleHandler.Target the target to write to, or `null` to start with an uninitialized target target) Construct a new instance.
public	ConsoleHandler(final ConsoleHandler.Target the target to write to, or `null` to start with an uninitialized target target, final Formatter the formatter to use formatter) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
private static ConsoleHandler.Target	defaultTarget()
public ErrorManager	Returns: the local error manager getLocalErrorManager() Get the local error manager.
public static boolean	Returns: `true` if there is a console, `false` otherwise hasConsole() Determine whether the console exists.
public static boolean	Returns: `true` if the console exists and supports graphical output; `false` otherwise or if graphical support cannot be passively detected isGraphicsSupportPassivelyDetected() Determine whether the console can be passively detected to support graphical output.
public static boolean	Returns: `true` if the console exists and supports truecolor output; `false` otherwise isTrueColor() Determine whether the console supports truecolor output.
public void	setErrorManager(final ErrorManager the new ErrorManager em) Overrides org.jboss.logmanager.ExtHandler.setErrorManager. Define an ErrorManager for this Handler.
public void	setOutputStream(final OutputStream the new output stream or `null` for none outputStream) Overrides org.jboss.logmanager.handlers.OutputStreamHandler.setOutputStream. Set the output stream to write to.
public void	setTarget(ConsoleHandler.Target the target to write to, or `null` to clear the target target) Set the target for this console handler.
private static OutputStream	wrap(final OutputStream outputStream)
private static Writer	wrap(final Writer writer)
public boolean	Returns: `true` if the image was written, or `false` if image support isn't found writeImagePng(InputStream the PNG image data stream to write (must not be `null`) imageData, int the number of text columns to occupy (0 for automatic) columns, int the number of text rows to occupy (0 for automatic) rows) Write a PNG image to the console log, if it is supported.

Inherited from org.jboss.logmanager.handlers.OutputStreamHandler:: getOutputStream setCharsetPrivate setWriter

Field Detail

err	back to summary
private static final OutputStream err

ESC	back to summary
private static final String ESC

localErrorManager	back to summary
private final ErrorManager localErrorManager

out	back to summary
private static final OutputStream out

Constructor Detail

ConsoleHandler	back to summary
public ConsoleHandler() Construct a new instance.

ConsoleHandler	back to summary
public ConsoleHandler(final Formatter formatter) Construct a new instance. Parameters formatter:Formatter the formatter to use

ConsoleHandler

back to summary

public ConsoleHandler(final Formatter formatter)

Construct a new instance.

Parameters

formatter:Formatter: the formatter to use

ConsoleHandler back to summary

ConsoleHandler	back to summary
public ConsoleHandler(final ConsoleHandler.Target target) Construct a new instance. Parameters target:ConsoleHandler.Target the target to write to, or `null` to start with an uninitialized target

public ConsoleHandler(final ConsoleHandler.Target target)

Construct a new instance.

Parameters

target:ConsoleHandler.Target: the target to write to, or null to start with an uninitialized target

ConsoleHandler back to summary

ConsoleHandler	back to summary
public ConsoleHandler(final ConsoleHandler.Target target, final Formatter formatter) Construct a new instance. Parameters target:ConsoleHandler.Target the target to write to, or `null` to start with an uninitialized target formatter:Formatter the formatter to use

public ConsoleHandler(final ConsoleHandler.Target target, final Formatter formatter)

Construct a new instance.

Parameters

target:ConsoleHandler.Target: the target to write to, or null to start with an uninitialized target
formatter:Formatter: the formatter to use

Method Detail

defaultTarget	back to summary
private static ConsoleHandler.Target defaultTarget()

getLocalErrorManager	back to summary
public ErrorManager getLocalErrorManager() Get the local error manager. This is an error manager that will publish errors to this console handler. The console handler itself should not use this error manager. Returns:ErrorManager the local error manager

getLocalErrorManager

back to summary

public ErrorManager getLocalErrorManager()

Get the local error manager. This is an error manager that will publish errors to this console handler. The console handler itself should not use this error manager.

Returns:ErrorManager: the local error manager

hasConsole back to summary

hasConsole	back to summary
public static boolean hasConsole() Determine whether the console exists. If the console does not exist, then the standard output stream will be used when `Target#CONSOLE` is selected as the output target. Returns:boolean `true` if there is a console, `false` otherwise

public static boolean hasConsole()

Determine whether the console exists. If the console does not exist, then the standard output stream will be used when Target#CONSOLE is selected as the output target.

Returns:boolean: true if there is a console, false otherwise

isGraphicsSupportPassivelyDetected back to summary

isGraphicsSupportPassivelyDetected	back to summary
public static boolean isGraphicsSupportPassivelyDetected() Determine whether the console can be passively detected to support graphical output. This call may be expensive, so the result should be captured for the lifetime of any formatter making use of this information. Returns:boolean `true` if the console exists and supports graphical output; `false` otherwise or if graphical support cannot be passively detected

public static boolean isGraphicsSupportPassivelyDetected()

Determine whether the console can be passively detected to support graphical output. This call may be expensive, so the result should be captured for the lifetime of any formatter making use of this information.

Returns:boolean: true if the console exists and supports graphical output; false otherwise or if graphical support cannot be passively detected

isTrueColor back to summary

isTrueColor	back to summary
public static boolean isTrueColor() Determine whether the console supports truecolor output. This call may be expensive, so the result should be captured for the lifetime of any formatter making use of this information. Returns:boolean `true` if the console exists and supports truecolor output; `false` otherwise

public static boolean isTrueColor()

Determine whether the console supports truecolor output. This call may be expensive, so the result should be captured for the lifetime of any formatter making use of this information.

Returns:boolean: true if the console exists and supports truecolor output; false otherwise

setErrorManager	back to summary
public void setErrorManager(final ErrorManager em) Overrides org.jboss.logmanager.ExtHandler.setErrorManager. Doc from java.util.logging.Handler.setErrorManager. Define an ErrorManager for this Handler. The ErrorManager's "error" method will be invoked if any errors occur while using this Handler. Parameters em:ErrorManager the new ErrorManager

setErrorManager

back to summary

public void setErrorManager(final ErrorManager em)

Overrides org.jboss.logmanager.ExtHandler.setErrorManager.

Doc from java.util.logging.Handler.setErrorManager.

Define an ErrorManager for this Handler.

The ErrorManager's "error" method will be invoked if any errors occur while using this Handler.

Parameters

em:ErrorManager: the new ErrorManager

setOutputStream back to summary

setOutputStream	back to summary
public void setOutputStream(final OutputStream outputStream) Overrides org.jboss.logmanager.handlers.OutputStreamHandler.setOutputStream. Doc from org.jboss.logmanager.handlers.OutputStreamHandler.setOutputStream. Set the output stream to write to. The output stream will then belong to this handler; when the handler is closed or a new writer or output stream is set, this output stream will be closed. Parameters outputStream:OutputStream the new output stream or `null` for none

public void setOutputStream(final OutputStream outputStream)

Overrides org.jboss.logmanager.handlers.OutputStreamHandler.setOutputStream.

Doc from org.jboss.logmanager.handlers.OutputStreamHandler.setOutputStream.

Set the output stream to write to. The output stream will then belong to this handler; when the handler is closed or a new writer or output stream is set, this output stream will be closed.

Parameters

outputStream:OutputStream: the new output stream or null for none

setTarget back to summary

setTarget	back to summary
public void setTarget(ConsoleHandler.Target target) Set the target for this console handler. Parameters target:ConsoleHandler.Target the target to write to, or `null` to clear the target

public void setTarget(ConsoleHandler.Target target)

Set the target for this console handler.

Parameters

target:ConsoleHandler.Target: the target to write to, or null to clear the target

wrap	back to summary
private static OutputStream wrap(final OutputStream outputStream)

wrap	back to summary
private static Writer wrap(final Writer writer)

writeImagePng back to summary

writeImagePng	back to summary
public boolean writeImagePng(InputStream imageData, int columns, int rows) throws IOException Write a PNG image to the console log, if it is supported. The image data stream must be closed by the caller. Parameters imageData:InputStream the PNG image data stream to write (must not be `null`) columns:int the number of text columns to occupy (0 for automatic) rows:int the number of text rows to occupy (0 for automatic) Returns:boolean `true` if the image was written, or `false` if image support isn't found Exceptions IOException: if the stream failed while writing the image

public boolean writeImagePng(InputStream imageData, int columns, int rows) throws IOException

Write a PNG image to the console log, if it is supported. The image data stream must be closed by the caller.

Parameters

imageData:InputStream: the PNG image data stream to write (must not be null)
columns:int: the number of text columns to occupy (0 for automatic)
rows:int: the number of text rows to occupy (0 for automatic)

Returns:boolean

true if the image was written, or false if image support isn't found

Exceptions

IOException:: if the stream failed while writing the image

org.jboss.logmanager.handlers back to summary

private final Class ConsoleHandler.ConsoleHolder

Class Inheritance

extends Object

java.lang.Object
org.jboss.logmanager.handlers.ConsoleHandler.ConsoleHolder

Field Summary

Modifier and Type	Field and Description
private static final PrintWriter	console

Constructor Summary

Access	Constructor and Description
private	ConsoleHolder()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

console	back to summary
private static final PrintWriter console

Constructor Detail

ConsoleHolder	back to summary
private ConsoleHolder()

org.jboss.logmanager.handlers back to summary

public final Enum ConsoleHandler.Target

Class Inheritance

extends Enum<ConsoleHandler.Target>

java.lang.Object
java.lang.Enum
org.jboss.logmanager.handlers.ConsoleHandler.Target

The target stream type.

Field Summary

Modifier and Type	Field and Description
public static final ConsoleHandler.Target	CONSOLE The target for `System#console()`.
public static final ConsoleHandler.Target	SYSTEM_ERR The target for `System#err`.
public static final ConsoleHandler.Target	SYSTEM_OUT The target for `System#out`.

Constructor Summary

Access	Constructor and Description
private	Target()

Method Summary

Modifier and Type	Method and Description
public static ConsoleHandler.Target	valueOf(String name)
public static ConsoleHandler.Target[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONSOLE	back to summary
public static final ConsoleHandler.Target CONSOLE The target for `System#console()`.

SYSTEM_ERR	back to summary
public static final ConsoleHandler.Target SYSTEM_ERR The target for `System#err`.

SYSTEM_OUT	back to summary
public static final ConsoleHandler.Target SYSTEM_OUT The target for `System#out`.

Constructor Detail

Target	back to summary
private Target()

Method Detail

valueOf	back to summary
public static ConsoleHandler.Target valueOf(String name)

values	back to summary
public static ConsoleHandler.Target[] values()

public Class ConsoleHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ConsoleHandler.ConsoleHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Enum ConsoleHandler.Target

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail