org.refcodes.textual.impls

Class EscapeTextBuilderImpl

java.lang.Object

org.refcodes.textual.impls.EscapeTextBuilderImpl

All Implemented Interfaces:

EscapeTextBuilder, Text<EscapeTextBuilder>, TextAccessor, TextAccessor.TextBuilder<Text<EscapeTextBuilder>>, TextAccessor.TextMutator, TextAccessor.TextProperty

public class EscapeTextBuilderImpl
extends Object
implements EscapeTextBuilder

Author:

steiner

Nested Class Summary

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

TextAccessor.TextBuilder<B extends TextAccessor.TextBuilder<B>>, TextAccessor.TextMutator, TextAccessor.TextProperty

Constructor Summary

Constructors

Constructor and Description
EscapeTextBuilderImpl()

Method Summary

Modifier and Type	Method and Description
EscapeTextBuilder	addEscapeProperty(org.refcodes.collection.Property aProperty)
EscapeTextBuilder	addEscapeProperty(String aKey, String aValue)
org.refcodes.collection.Property[]	getEscapeProperties()
EscapeTextMode	getEscapeTextMode() Retrieves the escape text mode from the escape text mode property.
String[]	getText() Retrieves the text from the text property.
void	setEscapeProperties(org.refcodes.collection.Property... aProperties)
void	setEscapeTextMode(EscapeTextMode aEscapeTextMode) Sets the escape text mode for the escape text mode property.
void	setText(String... aText) Sets the text for the text property.
protected String[]	toEscaped(String[] aText, List<org.refcodes.collection.Property> aProperties, EscapeTextMode aEscapeTextMode)
protected String	toEscaped(String aText, List<org.refcodes.collection.Property> aProperties, EscapeTextMode aEscapeTextMode)
static String	toEscaped(String aUnEscaped, String[][] aEscapeMatrix) Escapes a text using the provided escape matrix which must be a two dimensional array with two elements per line and where the element at position 0 (of a line) represents the character and the element at position 1 (of a line) the escaped character.
String	toString() The String being build by the builder upon the settings of the attributes.
String	toString(String... aText) Race condition safe shortcut for using Text.withText(String...)
String[]	toStrings() The Strings being escaped by the builder upon the settings of the attributes.
String[]	toStrings(String... aText) Race condition safe shortcut for using Text.withText(String...)
static String	toUnEscaped(String aEscaped, String[][] aEscapeMatrix) Unescapes a text using the provided escape matrix which must be a two dimensional array with two elements per line and where the element at position 0 (of a line) represents the character and the element at position 1 (of a line) the escaped character.
B	withText(Collection<String> aText) Sets the text for the text property.
B	withText(String... aText) Sets the text for the text property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.textual.EscapeTextBuilder

toString, withEscapeProperties, withEscapeTextMode

Methods inherited from interface org.refcodes.textual.Text

toString, withText

Methods inherited from interface org.refcodes.textual.TextAccessor

getText

Methods inherited from interface org.refcodes.textual.TextAccessor.TextMutator

setText, setText

Methods inherited from interface org.refcodes.textual.TextAccessor.TextBuilder

withText

Constructor Detail

EscapeTextBuilderImpl

public EscapeTextBuilderImpl()

Method Detail

getEscapeTextMode

public EscapeTextMode getEscapeTextMode()

Description copied from interface: EscapeTextBuilder

Retrieves the escape text mode from the escape text mode property.

Specified by:

getEscapeTextMode in interface EscapeTextBuilder

Returns:

The escape text mode stored by the escape text mode property.

setEscapeTextMode

public void setEscapeTextMode(EscapeTextMode aEscapeTextMode)

Description copied from interface: EscapeTextBuilder

Sets the escape text mode for the escape text mode property.

Specified by:

setEscapeTextMode in interface EscapeTextBuilder

Parameters:

aEscapeTextMode - The escape text mode to be stored by the align text mode property.

getEscapeProperties

public org.refcodes.collection.Property[] getEscapeProperties()

Specified by:

getEscapeProperties in interface EscapeTextBuilder

setEscapeProperties

public void setEscapeProperties(org.refcodes.collection.Property... aProperties)

Specified by:

setEscapeProperties in interface EscapeTextBuilder

addEscapeProperty

public EscapeTextBuilder addEscapeProperty(org.refcodes.collection.Property aProperty)

Specified by:

addEscapeProperty in interface EscapeTextBuilder

addEscapeProperty

public EscapeTextBuilder addEscapeProperty(String aKey,
                                           String aValue)

Specified by:

addEscapeProperty in interface EscapeTextBuilder

toStrings

public String[] toStrings()
                   throws IllegalStateException

Description copied from interface: EscapeTextBuilder

The Strings being escaped by the builder upon the settings of the attributes.

Specified by:

toStrings in interface EscapeTextBuilder

Specified by:

toStrings in interface Text<EscapeTextBuilder>

Returns:

The according resulting String array

Throws:

IllegalStateException

toStrings

public String[] toStrings(String... aText)

Description copied from interface: Text

Race condition safe shortcut for using Text.withText(String...) followed by Text.toStrings(). Implementation requirements: This method must not(!) be implemented by calling Text.withText(String...) followed by Text.toStrings() (do not change the text property) as this would not be thread safe!

Specified by:

toStrings in interface Text<EscapeTextBuilder>

Parameters:

aText - The text to be processed.

Returns:

The according resulting String array

toEscaped

protected String[] toEscaped(String[] aText,
                             List<org.refcodes.collection.Property> aProperties,
                             EscapeTextMode aEscapeTextMode)

toEscaped

protected String toEscaped(String aText,
                           List<org.refcodes.collection.Property> aProperties,
                           EscapeTextMode aEscapeTextMode)

toEscaped

public static String toEscaped(String aUnEscaped,
                               String[][] aEscapeMatrix)

Escapes a text using the provided escape matrix which must be a two dimensional array with two elements per line and where the element at position 0 (of a line) represents the character and the element at position 1 (of a line) the escaped character.

Parameters:

aUnEscaped - The text to be escaped.

aEscapeMatrix - The matrix to be used for escaping.

Returns:

The escape text as of the escape matrix.

toUnEscaped

public static String toUnEscaped(String aEscaped,
                                 String[][] aEscapeMatrix)

Unescapes a text using the provided escape matrix which must be a two dimensional array with two elements per line and where the element at position 0 (of a line) represents the character and the element at position 1 (of a line) the escaped character.

Parameters:

aEscaped - The text to be unescaped.

aEscapeMatrix - The matrix to be used for unescaping.

Returns:

The unescape text as of the escape matrix.

getText

public String[] getText()

Description copied from interface: TextAccessor

Retrieves the text from the text property.

Specified by:

getText in interface TextAccessor

Returns:

The text stored by the text property.

setText

public void setText(String... aText)

Description copied from interface: TextAccessor.TextMutator

Sets the text for the text property.

Specified by:

setText in interface TextAccessor.TextMutator

Parameters:

aText - The text to be stored by the text property.

withText

public B withText(String... aText)

Description copied from interface: TextAccessor.TextBuilder

Sets the text for the text property.

Specified by:

withText in interface Text<B extends Text<B>>

Specified by:

withText in interface TextAccessor.TextBuilder<Text<B extends Text<B>>>

Parameters:

aText - The text to be stored by the text property.

Returns:

The builder for applying multiple build operations.

withText

public B withText(Collection<String> aText)

Description copied from interface: TextAccessor.TextBuilder

Sets the text for the text property.

Specified by:

withText in interface TextAccessor.TextBuilder<Text<B extends Text<B>>>

Parameters:

aText - The text to be stored by the text property.

Returns:

The builder for applying multiple build operations.

toString

public String toString()

The String being build by the builder upon the settings of the attributes. The string array is returned as a single String with the operating system's end of line marker (CR on on Windows and CR LF on *nix operating systems) as determined by SystemUtility.getLineBreak()

Specified by:

toString in interface Text<B extends Text<B>>

Overrides:

toString in class Object

Returns:

The according resulting String

toString

public String toString(String... aText)

Description copied from interface: Text

Race condition safe shortcut for using Text.withText(String...) followed by Text.toString(). Implementation requirements: This method must not(!) be implemented by calling Text.withText(String...) followed by Text.toString() (do not change the text property) as this would not be thread safe!

Specified by:

toString in interface Text<B extends Text<B>>

Parameters:

aText - The text to be processed.

Returns:

The according resulting String