org.refcodes.logger.alt.console.impls

Class ConsoleLoggerImpl<T>

java.lang.Object

org.refcodes.logger.alt.console.impls.ConsoleLoggerImpl<T>

Type Parameters:

T - The type of the Record instances managed by the Logger.

All Implemented Interfaces:

org.refcodes.component.Destroyable, ConsoleLogger<T>, org.refcodes.logger.Logger<T>, org.refcodes.mixin.RowWidthAccessor, org.refcodes.mixin.RowWidthAccessor.RowWidthBuilder<ConsoleLogger<?>>, org.refcodes.mixin.RowWidthAccessor.RowWidthMutator, org.refcodes.mixin.RowWidthAccessor.RowWidthProperty, org.refcodes.textual.TableStyleAccessor, org.refcodes.textual.TableStyleAccessor.TableStyleBuilder<ConsoleLogger<?>>, org.refcodes.textual.TableStyleAccessor.TableStyleMutator, org.refcodes.textual.TableStyleAccessor.TableStyleProperty

public class ConsoleLoggerImpl<T>
extends Object
implements org.refcodes.component.Destroyable, ConsoleLogger<T>

The ConsoleLoggerImpl implements the Logger interface for providing logging functionality for extended pimped console output (via System.out and System.err to be used by RuntimeLogger implementations.

ATTENTION: As the table layout for the generated log lines makes only sense when all ConsoleLoggerImpl instances print out their output according to the last state of a previous output (from another instance of the ConsoleLoggerImpl), the "bean" attributes refer actually to static member variables: Their values are valid for all instances of this class!

Still the setters and getters are of "instance" scope (not static) to enable the builder-pattern to be applied.

The ConsoleLoggerImpl by default uses the SystemUtility.getConsoleWidth() method, which determines the width in characters of the system's console in use. In case you pass a "-Dconsole.width=n" JVM argument, then your width is taken, else the actual console's width is being tried to be determined. See SystemUtility#SYS_PROP_CONSOLE_WIDTH. You can also use the setRowWidth(int) or withRowWidth(int) method in order to programmatically set the console's row width.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

org.refcodes.component.Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.mixin.RowWidthAccessor

org.refcodes.mixin.RowWidthAccessor.RowWidthBuilder<B extends org.refcodes.mixin.RowWidthAccessor.RowWidthBuilder<?>>, org.refcodes.mixin.RowWidthAccessor.RowWidthMutator, org.refcodes.mixin.RowWidthAccessor.RowWidthProperty

Nested classes/interfaces inherited from interface org.refcodes.textual.TableStyleAccessor

org.refcodes.textual.TableStyleAccessor.TableStyleBuilder<B extends org.refcodes.textual.TableStyleAccessor.TableStyleBuilder<?>>, org.refcodes.textual.TableStyleAccessor.TableStyleMutator, org.refcodes.textual.TableStyleAccessor.TableStyleProperty

Constructor Summary

Constructors

Constructor and Description
ConsoleLoggerImpl() Initially enables or disables ANSI escape sequences as of detection of terminal's ANSI support.

Method Summary

Modifier and Type	Method and Description
void	destroy()
PrintStream	getErrStream()
PrintStream	getOutStream()
int	getRowWidth()
org.refcodes.textual.TableStyle	getTableStyle()
boolean	hasLeftBorder()
boolean	hasRightBorder()
void	log(org.refcodes.tabular.Record<? extends T> aRecord)
void	setErrStream(PrintStream aErrStream)
void	setEscCodes(boolean isEscCodesEnabled)
void	setLeftBorder(boolean hasLeftBorder)
void	setOutStream(PrintStream aOutStream)
void	setRightBorder(boolean hasRightBorder)
void	setRowWidth(int aRowWidth)
void	setTableStyle(org.refcodes.textual.TableStyle aTableStyle)
void	setTableStyleName(String aTableStyleName) As the underlying configuration framework used by the RuntimeLoggerSingleton cannot convert a String to an enum, we got to provide such a method ourselves.
ConsoleLogger<T>	withErrStream(PrintStream aErrStream)
ConsoleLogger<T>	withEscCodes(boolean isEscCodesEnabled)
ConsoleLogger<T>	withLeftBorder(boolean hasLeftBorder)
ConsoleLogger<T>	withOutStream(PrintStream aOutStream)
ConsoleLogger<T>	withRightBorder(boolean hasRightBorder)
ConsoleLogger<?>	withRowWidth(int aRowWidth)
ConsoleLogger<T>	withTableStyle(org.refcodes.textual.TableStyle aTableStyle)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleLoggerImpl

public ConsoleLoggerImpl()

Initially enables or disables ANSI escape sequences as of detection of terminal's ANSI support. You can overrule this setting by calling setEscCodes(boolean).

See Also:

SystemUtility.isAnsiSupported()

Method Detail

log

public void log(org.refcodes.tabular.Record<? extends T> aRecord)
         throws org.refcodes.logger.IllegalRecordRuntimeException,
                org.refcodes.logger.UnexpectedLogRuntimeException

Specified by:

log in interface org.refcodes.logger.Logger<T>

Throws:

org.refcodes.logger.IllegalRecordRuntimeException

org.refcodes.logger.UnexpectedLogRuntimeException

getOutStream

public PrintStream getOutStream()

Specified by:

getOutStream in interface ConsoleLogger<T>

setOutStream

public void setOutStream(PrintStream aOutStream)

Specified by:

setOutStream in interface ConsoleLogger<T>

getErrStream

public PrintStream getErrStream()

Specified by:

getErrStream in interface ConsoleLogger<T>

setErrStream

public void setErrStream(PrintStream aErrStream)

Specified by:

setErrStream in interface ConsoleLogger<T>

getTableStyle

public org.refcodes.textual.TableStyle getTableStyle()

Specified by:

getTableStyle in interface org.refcodes.textual.TableStyleAccessor

setTableStyle

public void setTableStyle(org.refcodes.textual.TableStyle aTableStyle)

Specified by:

setTableStyle in interface org.refcodes.textual.TableStyleAccessor.TableStyleMutator

setTableStyleName

public void setTableStyleName(String aTableStyleName)

Description copied from interface: ConsoleLogger

As the underlying configuration framework used by the RuntimeLoggerSingleton cannot convert a String to an enum, we got to provide such a method ourselves. When configuring programmatically use RowWidthAccessor.RowWidthMutator.setRowWidth(int) or RowWidthAccessor.RowWidthBuilder.withRowWidth(int), when using the "runtimelogger-config.xml" ise the property "tableStyleName" for this method to be invoked. Valid arguments are as of the TableStyle enumeration:

• SINGLE
• DOUBLE
• DOUBLE_SINGLE
• SINGLE_DOUBLE
• SINGLE_DASHED
• ASCII
• BLANK
• SINGLE_BLANK
• ASCII_BLANK

Specified by:

setTableStyleName in interface ConsoleLogger<T>

setEscCodes

public void setEscCodes(boolean isEscCodesEnabled)

Specified by:

setEscCodes in interface ConsoleLogger<T>

hasLeftBorder

public boolean hasLeftBorder()

Specified by:

hasLeftBorder in interface ConsoleLogger<T>

setLeftBorder

public void setLeftBorder(boolean hasLeftBorder)

Specified by:

setLeftBorder in interface ConsoleLogger<T>

hasRightBorder

public boolean hasRightBorder()

Specified by:

hasRightBorder in interface ConsoleLogger<T>

setRightBorder

public void setRightBorder(boolean hasRightBorder)

Specified by:

setRightBorder in interface ConsoleLogger<T>

getRowWidth

public int getRowWidth()

Specified by:

getRowWidth in interface org.refcodes.mixin.RowWidthAccessor

setRowWidth

public void setRowWidth(int aRowWidth)

Specified by:

setRowWidth in interface org.refcodes.mixin.RowWidthAccessor.RowWidthMutator

withOutStream

public ConsoleLogger<T> withOutStream(PrintStream aOutStream)

Specified by:

withOutStream in interface ConsoleLogger<T>

withErrStream

public ConsoleLogger<T> withErrStream(PrintStream aErrStream)

Specified by:

withErrStream in interface ConsoleLogger<T>

withTableStyle

public ConsoleLogger<T> withTableStyle(org.refcodes.textual.TableStyle aTableStyle)

Specified by:

withTableStyle in interface org.refcodes.textual.TableStyleAccessor.TableStyleBuilder<ConsoleLogger<?>>

withEscCodes

public ConsoleLogger<T> withEscCodes(boolean isEscCodesEnabled)

Specified by:

withEscCodes in interface ConsoleLogger<T>

withLeftBorder

public ConsoleLogger<T> withLeftBorder(boolean hasLeftBorder)

Specified by:

withLeftBorder in interface ConsoleLogger<T>

withRightBorder

public ConsoleLogger<T> withRightBorder(boolean hasRightBorder)

Specified by:

withRightBorder in interface ConsoleLogger<T>

withRowWidth

public ConsoleLogger<?> withRowWidth(int aRowWidth)

Specified by:

withRowWidth in interface org.refcodes.mixin.RowWidthAccessor.RowWidthBuilder<ConsoleLogger<?>>

destroy

public void destroy()

Specified by:

destroy in interface org.refcodes.component.Destroyable