org.refcodes.textual.impls

Class ColumnFormatMetricsImpl

java.lang.Object

org.refcodes.textual.impls.ColumnWidthMetricsImpl

org.refcodes.textual.impls.ColumnFormatMetricsImpl

All Implemented Interfaces:

org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, ColumnFormatMetrics, ColumnWidthMetrics, HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<ColumnFormatMetrics>, HorizAlignTextModeAccessor.HorizAlignTextModeMutator, MoreTextModeAccessor.MoreTextModeBuilder<ColumnFormatMetrics>, MoreTextModeAccessor.MoreTextModeMutator, SplitTextModeAccessor.SplitTextModeBuilder<ColumnFormatMetrics>, SplitTextModeAccessor.SplitTextModeMutator, TextFormatModeAccessor.TextFormatModeBuilder<ColumnFormatMetrics>, TextFormatModeAccessor.TextFormatModeMutator

Direct Known Subclasses:

ColumnSetupMetricsImpl

public class ColumnFormatMetricsImpl
extends ColumnWidthMetricsImpl
implements ColumnFormatMetrics

Implementation of the ColumnFormatMetrics interface.

Nested Class Summary

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

org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty

Constructor Summary

Constructors

Constructor and Description
ColumnFormatMetricsImpl()
ColumnFormatMetricsImpl(int aWidth, ColumnWidthType aWidthType) Constructs a column's width, either in percent (%) or in number of chars.

Method Summary

Modifier and Type	Method and Description
String	getHeaderEscapeCode() Returns the ANSI Escape-Code for the header.
EscapeCodeFactory	getHeaderEscapeCodeFactory() Gets the ANSI Escape-Code factory for the header.
HorizAlignTextMode	getHeaderHorizAlignTextMode() Gets the alignment mode for the header.
MoreTextMode	getHeaderMoreTextMode() Gets the alignment mode for the header.
SplitTextMode	getHeaderSplitTextMode() Returns the SplitTextMode for the header.
TextFormatMode	getHeaderTextFormatMode() Returns the TextFormatMode for the header.
String	getRowEscapeCode() Returns the ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the builder pattern.
EscapeCodeFactory	getRowEscapeCodeFactory() Gets the ANSI Escape-Code factory for the row.
HorizAlignTextMode	getRowHorizAlignTextMode() Gets the alignment mode for the row.
MoreTextMode	getRowMoreTextMode() Gets the alignment mode for the row.
SplitTextMode	getRowSplitTextMode() Returns the SplitTextMode for the row.
TextFormatMode	getRowTextFormatMode() Returns the TextFormatMode for the row.
void	setEscapeCode(String aEscapeCode) Sets an ANSI Escape-Code for the header and the rows.
void	setHeaderEscapeCode(String aEscapeCode) Sets an ANSI Escape-Code for the header.
void	setHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory) Sets an ANSI Escape-Code factory for the header.
void	setHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode) Sets an alignment mode for the header.
void	setHeaderMoreTextMode(MoreTextMode aMoreTextMode) Sets a more-text mode for the header.
void	setHeaderSplitTextMode(SplitTextMode aSplitTextMode) Sets the SplitTextMode for the header.
void	setHeaderTextFormatMode(TextFormatMode aTextFormatMode) Sets the TextFormatMode for the header.
void	setMoreTextMode(MoreTextMode aMoreTextMode) Sets the more-text mode for the more-text mode property.
void	setRowEscapeCode(String aEscapeCode) Sets an ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the builder pattern.
void	setRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory) Sets an ANSI Escape-Code factory for the row.
void	setRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode) Sets an alignment mode for the row.
void	setRowMoreTextMode(MoreTextMode aMoreTextMode) Sets a more-text mode for the row.
void	setRowSplitTextMode(SplitTextMode aSplitTextMode) Sets the SplitTextMode for the row.
void	setRowTextFormatMode(TextFormatMode aTextFormatMode) Sets the TextFormatMode for the row.
String	toHeaderEscapeCode(Object aIdentifier) Determines the ANSI Escape-Code by evaluating the provided ID: If an EscapeCodeFactory has been set via ColumnFormatMetrics.setEscapeCodeFactory(EscapeCodeFactory) and the factory returns a value different to null, then this value is returned.
String	toRowEscapeCode(Object aIdentifier) Determines the ANSI Escape-Code by evaluating the provided ID: If an EscapeCodeFactory has been set via ColumnFormatMetrics.setEscapeCodeFactory(EscapeCodeFactory) and the factory returns a value different to null, then this value is returned.
ColumnFormatMetrics	withColumnWidth(int aColumnWidth)

Methods inherited from class org.refcodes.textual.impls.ColumnWidthMetricsImpl

getColumnWidth, getColumnWidthType, setColumnWidth, setColumnWidthType, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.textual.ColumnFormatMetrics

fromColumnFormatMetrics, setEscapeCodeFactory, setHorizAlignTextMode, setSplitTextMode, setTextFormatMode, withColumnWidthType, withEscapeCode, withEscapeCodeFactory, withHeaderEscapeCode, withHeaderEscapeCodeFactory, withHeaderHorizAlignTextMode, withHeaderMoreTextMode, withHeaderSplitTextMode, withHeaderTextFormatMode, withHorizAlignTextMode, withMoreTextMode, withRowEscapeCode, withRowEscapeCodeFactory, withRowHorizAlignTextMode, withRowMoreTextMode, withRowSplitTextMode, withRowTextFormatMode, withSplitTextMode, withTextFormatMode

Methods inherited from interface org.refcodes.textual.ColumnWidthMetrics

fromColumnWidthMetrics, getColumnWidthType, setColumnWidthType

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

getColumnWidth

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator

setColumnWidth

Constructor Detail

ColumnFormatMetricsImpl

public ColumnFormatMetricsImpl()

ColumnFormatMetricsImpl

public ColumnFormatMetricsImpl(int aWidth,
                               ColumnWidthType aWidthType)

Constructs a column's width, either in percent (%) or in number of chars.

Parameters:

aWidth - The width for the column, either in percent (%) or in number of chars, depending on the provided ColumnWidthType .

aWidthType - The type of the width being provided, either percent (%) or number of chars.

Method Detail

withColumnWidth

public ColumnFormatMetrics withColumnWidth(int aColumnWidth)

Specified by:

withColumnWidth in interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>

Specified by:

withColumnWidth in interface ColumnFormatMetrics

Overrides:

withColumnWidth in class ColumnWidthMetricsImpl

setEscapeCode

public void setEscapeCode(String aEscapeCode)

Description copied from interface: ColumnFormatMetrics

Sets an ANSI Escape-Code for the header and the rows. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

setEscapeCode in interface ColumnFormatMetrics

Parameters:

aEscapeCode - The String to be used for ANSI escaping.

setHeaderEscapeCode

public void setHeaderEscapeCode(String aEscapeCode)

Description copied from interface: ColumnFormatMetrics

Sets an ANSI Escape-Code for the header. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

setHeaderEscapeCode in interface ColumnFormatMetrics

Parameters:

aEscapeCode - The String to be used for ANSI escaping.

getHeaderEscapeCode

public String getHeaderEscapeCode()

Description copied from interface: ColumnFormatMetrics

Returns the ANSI Escape-Code for the header. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

getHeaderEscapeCode in interface ColumnFormatMetrics

Returns:

The String to be used for ANSI escaping.

setRowEscapeCode

public void setRowEscapeCode(String aEscapeCode)

Description copied from interface: ColumnFormatMetrics

Sets an ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the builder pattern. The latest ANSI Escape-Code being set wins.

Specified by:

setRowEscapeCode in interface ColumnFormatMetrics

Parameters:

aEscapeCode - The String to be used for ANSI escaping.

getRowEscapeCode

public String getRowEscapeCode()

Description copied from interface: ColumnFormatMetrics

Returns the ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the builder pattern. The latest ANSI Escape-Code being set wins.

Specified by:

getRowEscapeCode in interface ColumnFormatMetrics

Returns:

The String to be used for ANSI escaping.

setMoreTextMode

public void setMoreTextMode(MoreTextMode aMoreTextMode)

Description copied from interface: MoreTextModeAccessor.MoreTextModeMutator

Sets the more-text mode for the more-text mode property.

Specified by:

setMoreTextMode in interface ColumnFormatMetrics

Specified by:

setMoreTextMode in interface MoreTextModeAccessor.MoreTextModeMutator

Parameters:

aMoreTextMode - The more-text mode to be stored by the more-text mode property.

setHeaderHorizAlignTextMode

public void setHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Description copied from interface: ColumnFormatMetrics

Sets an alignment mode for the header.

Specified by:

setHeaderHorizAlignTextMode in interface ColumnFormatMetrics

Parameters:

aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.

getHeaderHorizAlignTextMode

public HorizAlignTextMode getHeaderHorizAlignTextMode()

Description copied from interface: ColumnFormatMetrics

Gets the alignment mode for the header.

Specified by:

getHeaderHorizAlignTextMode in interface ColumnFormatMetrics

Returns:

The HorizAlignTextMode to be used for aligning the text.

setRowHorizAlignTextMode

public void setRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Description copied from interface: ColumnFormatMetrics

Sets an alignment mode for the row.

Specified by:

setRowHorizAlignTextMode in interface ColumnFormatMetrics

Parameters:

aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.

getRowHorizAlignTextMode

public HorizAlignTextMode getRowHorizAlignTextMode()

Description copied from interface: ColumnFormatMetrics

Gets the alignment mode for the row.

Specified by:

getRowHorizAlignTextMode in interface ColumnFormatMetrics

Returns:

The HorizAlignTextMode to be used for aligning the text.

setHeaderMoreTextMode

public void setHeaderMoreTextMode(MoreTextMode aMoreTextMode)

Description copied from interface: ColumnFormatMetrics

Sets a more-text mode for the header.

Specified by:

setHeaderMoreTextMode in interface ColumnFormatMetrics

Parameters:

aMoreTextMode - The MoreTextMode to be used for truncating the text.

getHeaderMoreTextMode

public MoreTextMode getHeaderMoreTextMode()

Description copied from interface: ColumnFormatMetrics

Gets the alignment mode for the header.

Specified by:

getHeaderMoreTextMode in interface ColumnFormatMetrics

Returns:

The MoreTextMode to be used for truncating the text.

setRowMoreTextMode

public void setRowMoreTextMode(MoreTextMode aMoreTextMode)

Description copied from interface: ColumnFormatMetrics

Sets a more-text mode for the row.

Specified by:

setRowMoreTextMode in interface ColumnFormatMetrics

Parameters:

aMoreTextMode - The MoreTextMode to be used for truncating the text.

getRowMoreTextMode

public MoreTextMode getRowMoreTextMode()

Description copied from interface: ColumnFormatMetrics

Gets the alignment mode for the row.

Specified by:

getRowMoreTextMode in interface ColumnFormatMetrics

Returns:

The MoreTextMode to be used for truncating the text.

setHeaderTextFormatMode

public void setHeaderTextFormatMode(TextFormatMode aTextFormatMode)

Description copied from interface: ColumnFormatMetrics

Sets the TextFormatMode for the header.

Specified by:

setHeaderTextFormatMode in interface ColumnFormatMetrics

Parameters:

aTextFormatMode - The TextFormatMode to be set for the header;

getHeaderTextFormatMode

public TextFormatMode getHeaderTextFormatMode()

Description copied from interface: ColumnFormatMetrics

Returns the TextFormatMode for the header.

Specified by:

getHeaderTextFormatMode in interface ColumnFormatMetrics

Returns:

The TextFormatMode to be set for the header;

setRowTextFormatMode

public void setRowTextFormatMode(TextFormatMode aTextFormatMode)

Description copied from interface: ColumnFormatMetrics

Sets the TextFormatMode for the row.

Specified by:

setRowTextFormatMode in interface ColumnFormatMetrics

Parameters:

aTextFormatMode - The TextFormatMode to be set for the row;

getRowTextFormatMode

public TextFormatMode getRowTextFormatMode()

Description copied from interface: ColumnFormatMetrics

Returns the TextFormatMode for the row.

Specified by:

getRowTextFormatMode in interface ColumnFormatMetrics

Returns:

The TextFormatMode to be set for the row;

setHeaderSplitTextMode

public void setHeaderSplitTextMode(SplitTextMode aSplitTextMode)

Description copied from interface: ColumnFormatMetrics

Sets the SplitTextMode for the header.

Specified by:

setHeaderSplitTextMode in interface ColumnFormatMetrics

Parameters:

aSplitTextMode - The SplitTextMode to be set for the header;

getHeaderSplitTextMode

public SplitTextMode getHeaderSplitTextMode()

Description copied from interface: ColumnFormatMetrics

Returns the SplitTextMode for the header.

Specified by:

getHeaderSplitTextMode in interface ColumnFormatMetrics

Returns:

The SplitTextMode to be set for the header;

setRowSplitTextMode

public void setRowSplitTextMode(SplitTextMode aSplitTextMode)

Description copied from interface: ColumnFormatMetrics

Sets the SplitTextMode for the row.

Specified by:

setRowSplitTextMode in interface ColumnFormatMetrics

Parameters:

aSplitTextMode - The SplitTextMode to be set for the row;

getRowSplitTextMode

public SplitTextMode getRowSplitTextMode()

Description copied from interface: ColumnFormatMetrics

Returns the SplitTextMode for the row.

Specified by:

getRowSplitTextMode in interface ColumnFormatMetrics

Returns:

The SplitTextMode to be set for the row;

setHeaderEscapeCodeFactory

public void setHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Description copied from interface: ColumnFormatMetrics

Sets an ANSI Escape-Code factory for the header. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

setHeaderEscapeCodeFactory in interface ColumnFormatMetrics

Parameters:

aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.

getHeaderEscapeCodeFactory

public EscapeCodeFactory getHeaderEscapeCodeFactory()

Description copied from interface: ColumnFormatMetrics

Gets the ANSI Escape-Code factory for the header. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

getHeaderEscapeCodeFactory in interface ColumnFormatMetrics

Returns:

The EscapeCodeFactory to be used for determining ANSI escaping.

toHeaderEscapeCode

public String toHeaderEscapeCode(Object aIdentifier)

Description copied from interface: ColumnFormatMetrics

Determines the ANSI Escape-Code by evaluating the provided ID: If an EscapeCodeFactory has been set via ColumnFormatMetrics.setEscapeCodeFactory(EscapeCodeFactory) and the factory returns a value different to null, then this value is returned. Else the value returned by ColumnFormatMetrics.getHeaderEscapeCode() is returned as fallback.

Specified by:

toHeaderEscapeCode in interface ColumnFormatMetrics

Parameters:

aIdentifier - The ID for which to lookup an Escape-Code.

Returns:

The identified Escape-Code or null if none was identifiable.

setRowEscapeCodeFactory

public void setRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Description copied from interface: ColumnFormatMetrics

Sets an ANSI Escape-Code factory for the row. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

setRowEscapeCodeFactory in interface ColumnFormatMetrics

Parameters:

aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping. configuration.

getRowEscapeCodeFactory

public EscapeCodeFactory getRowEscapeCodeFactory()

Description copied from interface: ColumnFormatMetrics

Gets the ANSI Escape-Code factory for the row. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

getRowEscapeCodeFactory in interface ColumnFormatMetrics

Returns:

The EscapeCodeFactory to be used for determining ANSI escaping.

toRowEscapeCode

public String toRowEscapeCode(Object aIdentifier)

Description copied from interface: ColumnFormatMetrics

Determines the ANSI Escape-Code by evaluating the provided ID: If an EscapeCodeFactory has been set via ColumnFormatMetrics.setEscapeCodeFactory(EscapeCodeFactory) and the factory returns a value different to null, then this value is returned. Else the value returned by ColumnFormatMetrics.getRowEscapeCode() is returned as fallback.

Specified by:

toRowEscapeCode in interface ColumnFormatMetrics

Parameters:

aIdentifier - The ID for which to lookup an Escape-Code.

Returns:

The identified Escape-Code or null if none was identifiable.