org.refcodes.logger.alt.console

Class ConsoleLoggerSingleton

java.lang.Object

org.refcodes.logger.alt.console.ConsoleLoggerSingleton

All Implemented Interfaces:

ConsoleLogger, FormattedLogger<Object>, org.refcodes.logger.ColumnLayoutAccessor, org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutBuilder<ConsoleLogger>, org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutMutator, org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutProperty, org.refcodes.logger.Logger<Object>, org.refcodes.mixin.ErrorPrintStreamAccessor, org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamBuilder<FormattedLogger<Object>>, org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamMutator, org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamProperty, org.refcodes.mixin.RowWidthAccessor, org.refcodes.mixin.RowWidthAccessor.RowWidthBuilder<FormattedLogger<?>>, org.refcodes.mixin.RowWidthAccessor.RowWidthMutator, org.refcodes.mixin.RowWidthAccessor.RowWidthProperty, org.refcodes.mixin.StandardPrintStreamAccessor, org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamBuilder<FormattedLogger<Object>>, org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamMutator, org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamProperty, org.refcodes.textual.TableStyleAccessor, org.refcodes.textual.TableStyleAccessor.TableStyleBuilder<FormattedLogger<?>>, org.refcodes.textual.TableStyleAccessor.TableStyleMutator, org.refcodes.textual.TableStyleAccessor.TableStyleProperty

public class ConsoleLoggerSingleton
extends Object
implements ConsoleLogger

This ConsoleLoggerSingleton provides a ConsoleLoggerImpl singleton .

Nested Class Summary

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

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

org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamBuilder<B extends org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamBuilder<?>>, org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamMutator, org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamProperty

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

org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamBuilder<B extends org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamBuilder<?>>, org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamMutator, org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamProperty

Nested classes/interfaces inherited from interface org.refcodes.logger.ColumnLayoutAccessor

org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutBuilder<B extends org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutBuilder<B>>, org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutMutator, org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutProperty

Constructor Summary

Constructors

Constructor and Description
ConsoleLoggerSingleton() Constructor for constructing a pseudo singleton; this constructor is public to provide means to some configuration frameworks (such as commons-configurations from Apache) for using this ConsoleLoggerSingleton even when not being able to access the getInstance() method.

Method Summary

Modifier and Type	Method and Description
org.refcodes.logger.ColumnLayout	getColumnLayout()
PrintStream	getErrorPrintStream()
static ConsoleLoggerImpl	getInstance() Returns the singleton's instance as fabricated by this ConsoleLoggerSingleton.
int	getRowWidth()
PrintStream	getStandardPrintStream()
org.refcodes.textual.TableStyle	getTableStyle()
boolean	hasEscapeCodes() Checks for escape codes.
boolean	hasLeftBorder() Checks for left border.
boolean	hasRightBorder() Checks for right border.
void	log(org.refcodes.tabular.Record<? extends Object> aRecord)
void	printSeparator()
void	setColumnLayout(org.refcodes.logger.ColumnLayout aColumnLayout)
void	setErrorPrintStream(PrintStream aErrStream)
void	setEscapeCodes(boolean isEscCodesEnabled) Sets the escape codes.
void	setLeftBorder(boolean hasLeftBorder) Sets the left border.
void	setLoggerLayout(String aLoggerLayout) As the underlying configuration framework used by the RuntimeLoggerSingleton cannot convert a String to an enum, we got to provide such a method ourselves.
void	setLoggerStyle(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.
void	setRightBorder(boolean hasRightBorder) Sets the right border.
void	setRowWidth(int aRowWidth)
void	setStandardPrintStream(PrintStream aOutStream)
void	setTableStyle(org.refcodes.textual.TableStyle aTableStyle)
ConsoleLoggerSingleton	withErrorPrintStream(PrintStream aErrStream)
ConsoleLoggerSingleton	withEscapeCodes(boolean isEscCodesEnabled) With escape codes.
ConsoleLoggerSingleton	withLeftBorder(boolean hasLeftBorder) With left border.
ConsoleLoggerSingleton	withRightBorder(boolean hasRightBorder) With right border.
ConsoleLoggerSingleton	withRowWidth(int aRowWidth)
ConsoleLoggerSingleton	withStandardPrintStream(PrintStream aOutStream)
ConsoleLoggerSingleton	withTableStyle(org.refcodes.textual.TableStyle aTableStyle)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.logger.alt.console.ConsoleLogger

withColumnLayout

Constructor Detail

ConsoleLoggerSingleton

public ConsoleLoggerSingleton()

Constructor for constructing a pseudo singleton; this constructor is public to provide means to some configuration frameworks (such as commons-configurations from Apache) for using this ConsoleLoggerSingleton even when not being able to access the getInstance() method. The instance overhead for providing singleton behavior is taken into account.

Method Detail

getInstance

public static ConsoleLoggerImpl getInstance()
                                     throws org.refcodes.logger.LoggerInstantiationRuntimeException

Returns the singleton's instance as fabricated by this ConsoleLoggerSingleton.

Returns:

The RuntimeLogger singleton's instance.

Throws:

org.refcodes.logger.LoggerInstantiationRuntimeException - Thrown in case instantiating a Logger (RuntimeLogger) failed

log

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

Specified by:

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

Throws:

org.refcodes.logger.IllegalRecordRuntimeException

org.refcodes.logger.UnexpectedLogRuntimeException

getStandardPrintStream

public PrintStream getStandardPrintStream()

Specified by:

getStandardPrintStream in interface org.refcodes.mixin.StandardPrintStreamAccessor

setStandardPrintStream

public void setStandardPrintStream(PrintStream aOutStream)

Specified by:

setStandardPrintStream in interface org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamMutator

getErrorPrintStream

public PrintStream getErrorPrintStream()

Specified by:

getErrorPrintStream in interface org.refcodes.mixin.ErrorPrintStreamAccessor

setErrorPrintStream

public void setErrorPrintStream(PrintStream aErrStream)

Specified by:

setErrorPrintStream in interface org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamMutator

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

setLoggerStyle

public void setLoggerStyle(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. When configuring programmatically use TableStyleAccessor.TableStyleMutator.setTableStyle(TableStyle), when using the "runtimelogger-config.xml" use the property "loggerStyle" 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:

setLoggerStyle in interface FormattedLogger<Object>

Parameters:

aTableStyleName - The style to use for the logger.

setEscapeCodes

public void setEscapeCodes(boolean isEscCodesEnabled)

Sets the escape codes.

Specified by:

setEscapeCodes in interface FormattedLogger<Object>

Parameters:

isEscCodesEnabled - the new escape codes

hasLeftBorder

public boolean hasLeftBorder()

Checks for left border.

Specified by:

hasLeftBorder in interface FormattedLogger<Object>

Returns:

true, if successful

setLeftBorder

public void setLeftBorder(boolean hasLeftBorder)

Sets the left border.

Specified by:

setLeftBorder in interface FormattedLogger<Object>

Parameters:

hasLeftBorder - the new left border

hasRightBorder

public boolean hasRightBorder()

Checks for right border.

Specified by:

hasRightBorder in interface FormattedLogger<Object>

Returns:

true, if successful

setRightBorder

public void setRightBorder(boolean hasRightBorder)

Sets the right border.

Specified by:

setRightBorder in interface FormattedLogger<Object>

Parameters:

hasRightBorder - the new right border

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

printSeparator

public void printSeparator()

Specified by:

printSeparator in interface org.refcodes.logger.Logger<Object>

withStandardPrintStream

public ConsoleLoggerSingleton withStandardPrintStream(PrintStream aOutStream)

Specified by:

withStandardPrintStream in interface ConsoleLogger

Specified by:

withStandardPrintStream in interface FormattedLogger<Object>

Specified by:

withStandardPrintStream in interface org.refcodes.mixin.StandardPrintStreamAccessor.StandardPrintStreamBuilder<FormattedLogger<Object>>

withErrorPrintStream

public ConsoleLoggerSingleton withErrorPrintStream(PrintStream aErrStream)

Specified by:

withErrorPrintStream in interface ConsoleLogger

Specified by:

withErrorPrintStream in interface FormattedLogger<Object>

Specified by:

withErrorPrintStream in interface org.refcodes.mixin.ErrorPrintStreamAccessor.ErrorPrintStreamBuilder<FormattedLogger<Object>>

withTableStyle

public ConsoleLoggerSingleton withTableStyle(org.refcodes.textual.TableStyle aTableStyle)

Specified by:

withTableStyle in interface ConsoleLogger

Specified by:

withTableStyle in interface FormattedLogger<Object>

Specified by:

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

withEscapeCodes

public ConsoleLoggerSingleton withEscapeCodes(boolean isEscCodesEnabled)

With escape codes.

Specified by:

withEscapeCodes in interface ConsoleLogger

Specified by:

withEscapeCodes in interface FormattedLogger<Object>

Parameters:

isEscCodesEnabled - the is esc codes enabled

Returns:

the formatted logger

withLeftBorder

public ConsoleLoggerSingleton withLeftBorder(boolean hasLeftBorder)

With left border.

Specified by:

withLeftBorder in interface ConsoleLogger

Specified by:

withLeftBorder in interface FormattedLogger<Object>

Parameters:

hasLeftBorder - the has left border

Returns:

the formatted logger

withRightBorder

public ConsoleLoggerSingleton withRightBorder(boolean hasRightBorder)

With right border.

Specified by:

withRightBorder in interface ConsoleLogger

Specified by:

withRightBorder in interface FormattedLogger<Object>

Parameters:

hasRightBorder - the has right border

Returns:

the formatted logger

withRowWidth

public ConsoleLoggerSingleton withRowWidth(int aRowWidth)

Specified by:

withRowWidth in interface ConsoleLogger

Specified by:

withRowWidth in interface FormattedLogger<Object>

Specified by:

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

setLoggerLayout

public void setLoggerLayout(String aLoggerLayout)

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 ColumnLayoutAccessor.ColumnLayoutMutator.setColumnLayout(ColumnLayout), when using the "runtimelogger-config.xml" use the property "loggerLayout" for this method to be invoked. Valid arguments are as of the ColumnLayout enumeration:

• SUPERUSER
• FALLBACK
• DEVELOPER
• DEVOPS
• END_USER

Specified by:

setLoggerLayout in interface ConsoleLogger

Parameters:

aLoggerLayout - the new logger layout

hasEscapeCodes

public boolean hasEscapeCodes()

Checks for escape codes.

Specified by:

hasEscapeCodes in interface FormattedLogger<Object>

Returns:

true, if successful

getColumnLayout

public org.refcodes.logger.ColumnLayout getColumnLayout()

Specified by:

getColumnLayout in interface org.refcodes.logger.ColumnLayoutAccessor

setColumnLayout

public void setColumnLayout(org.refcodes.logger.ColumnLayout aColumnLayout)

Specified by:

setColumnLayout in interface org.refcodes.logger.ColumnLayoutAccessor.ColumnLayoutMutator