Package org.refcodes.textual

Interface EscapeTextBuilder

All Superinterfaces:

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

All Known Implementing Classes:

EscapeTextBuilderImpl

public interface EscapeTextBuilder
extends Text<EscapeTextBuilder>

The Interface 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, TextAccessor.TextProvider

Method Summary

Modifier and Type	Method	Description
EscapeTextBuilder	addEscapeProperty(String aKey, String aValue)	Adds the escape property.
EscapeTextBuilder	addEscapeProperty(org.refcodes.structure.Property aProperty)	Adds the escape property.
static EscapeTextBuilder	build()	This is a convenience method for easily instantiating the according builder.
org.refcodes.structure.Property[]	getEscapeProperties()	Gets the escape properties.
EscapeTextMode	getEscapeTextMode()	Retrieves the escape text mode from the escape text mode property.
void	setEscapeProperties(org.refcodes.structure.Property... aProperties)	Sets the escape properties.
void	setEscapeTextMode(EscapeTextMode aEscapeTextMode)	Sets the escape text mode for the escape text mode property.
String	toString()	The String being escaped by the builder upon the settings of the attributes.
String[]	toStrings()	The Strings being escaped by the builder upon the settings of the attributes.
default EscapeTextBuilder	withEscapeProperties(org.refcodes.structure.Property... aProperties)	With escape properties.
default EscapeTextBuilder	withEscapeTextMode(EscapeTextMode aEscapeTextMode)	Sets the escape text mode for the escape text mode property.

Methods inherited from interface org.refcodes.textual.Text

toString, toStrings, withText

Methods inherited from interface org.refcodes.textual.TextAccessor

getText

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

withText

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

setText, setText

Method Detail

getEscapeTextMode

EscapeTextMode getEscapeTextMode()

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

Returns:

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

setEscapeTextMode

void setEscapeTextMode(EscapeTextMode aEscapeTextMode)

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

Parameters:

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

withEscapeTextMode

default EscapeTextBuilder withEscapeTextMode(EscapeTextMode aEscapeTextMode)

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

Parameters:

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

Returns:

The builder for applying multiple build operations.

getEscapeProperties

org.refcodes.structure.Property[] getEscapeProperties()

Gets the escape properties.

Returns:

the escape properties

setEscapeProperties

void setEscapeProperties(org.refcodes.structure.Property... aProperties)

Sets the escape properties.

Parameters:

aProperties - the new escape properties

withEscapeProperties

default EscapeTextBuilder withEscapeProperties(org.refcodes.structure.Property... aProperties)

With escape properties.

Parameters:

aProperties - the properties

Returns:

the escape text builder

addEscapeProperty

EscapeTextBuilder addEscapeProperty(org.refcodes.structure.Property aProperty)

Adds the escape property.

Parameters:

aProperty - the property

Returns:

the escape text builder

addEscapeProperty

EscapeTextBuilder addEscapeProperty(String aKey,
                                    String aValue)

Adds the escape property.

Parameters:

aKey - the key

aValue - the value

Returns:

the escape text builder

toStrings

String[] toStrings()

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

Specified by:

toStrings in interface TextAccessor.TextProvider

Returns:

The according resulting String array

toString

String toString()
         throws IllegalStateException

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

Specified by:

toString in interface TextAccessor.TextProvider

Overrides:

toString in class Object

Returns:

The according resulting String

Throws:

IllegalStateException - Thrown in case more than one text line has been set via the Text.withText(String...) or TextAccessor.TextMutator.setText(String...) methods.

build

static EscapeTextBuilder build()

This is a convenience method for easily instantiating the according builder.

Returns:

an instance (using a default implementation) of this builder