Package org.refcodes.textual

Interface MoreTextBuilder

All Superinterfaces:

org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<MoreTextBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, Text<MoreTextBuilder>, TextAccessor, TextAccessor.TextBuilder<MoreTextBuilder>, TextAccessor.TextMutator, TextAccessor.TextProperty, TextAccessor.TextProvider

All Known Implementing Classes:

MoreTextBuilderImpl

public interface MoreTextBuilder
extends Text<MoreTextBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<MoreTextBuilder>

A builder for processing a text with the given width applied and the given MoreTextMode applied.

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

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
static MoreTextBuilder	build()	This is a convenience method for easily instantiating the according builder.
String	getMoreText()	Retrieves the more text from the more text property.
MoreTextMode	getMoreTextMode()	Retrieves the more text mode from the more text mode property.
void	setMoreText(String aMoreText)	Sets the more text for the more text property.
void	setMoreTextMode(MoreTextMode aMoreTextMode)	Sets the more text mode for the more text mode property.
String	toString()	The String being build by the builder upon the settings of the attributes.
String[]	toStrings()	The Strings being build by the builder upon the settings of the attributes.
default MoreTextBuilder	withColumnWidth(int aColumnWidth)
default MoreTextBuilder	withMoreText(String aMoreText)	Sets the more text for the more text property.
default MoreTextBuilder	withMoreTextMode(MoreTextMode aMoreTextMode)	Sets the more text mode for the more text mode property.

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

getColumnWidth

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

setColumnWidth

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

withColumnWidth

default MoreTextBuilder withColumnWidth(int aColumnWidth)

Specified by:

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

getMoreTextMode

MoreTextMode getMoreTextMode()

Retrieves the more text mode from the more text mode property.

Returns:

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

setMoreTextMode

void setMoreTextMode(MoreTextMode aMoreTextMode)

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

Parameters:

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

withMoreTextMode

default MoreTextBuilder withMoreTextMode(MoreTextMode aMoreTextMode)

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

Parameters:

aMoreTextMode - the more text mode

Returns:

The builder for applying multiple build operations.

getMoreText

String getMoreText()

Retrieves the more text from the more text property.

Returns:

The more text stored by the more text property.

setMoreText

void setMoreText(String aMoreText)

Sets the more text for the more text property.

Parameters:

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

withMoreText

default MoreTextBuilder withMoreText(String aMoreText)

Sets the more text for the more text property.

Parameters:

aMoreText - the more text

Returns:

The builder for applying multiple build operations.

toStrings

String[] toStrings()

The Strings being build 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 build 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 MoreTextBuilder build()

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

Returns:

an instance (using a default implementation) of this builder