Package org.refcodes.textual
Interface OverwriteTextBuilder
-
- All Superinterfaces:
Text<OverwriteTextBuilder>
,TextAccessor
,TextAccessor.TextBuilder<OverwriteTextBuilder>
,TextAccessor.TextMutator
,TextAccessor.TextProperty
,TextAccessor.TextProvider
- All Known Implementing Classes:
OverwriteTextBuilderImpl
public interface OverwriteTextBuilder extends Text<OverwriteTextBuilder>
Overwrites a text with another one to the the right or to the left.
-
-
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
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static OverwriteTextBuilder
build()
This is a convenience method for easily instantiating the according builder.OverwriteTextMode
getOverwriteTextMode()
Retrieves the overwrite text mode from the overwrite text mode property.String
getOverwritingText()
Retrieves the overwriting text from the overwriting text property.void
setOverwritingText(String aOverwritingText)
Sets the overwriting text for the overwriting text property.void
setTextOverwriteMode(OverwriteTextMode aTextOverwriteMode)
Sets the overwrite text mode for the overwrite text mode property.default OverwriteTextBuilder
withOverwriteTextMode(OverwriteTextMode aOverwriteTextMode)
Sets the overwrite text mode for the overwrite text mode property.default OverwriteTextBuilder
withOverwritingText(String aOverwritingText)
Sets the overwriting text for the overwriting text property.-
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
-
Methods inherited from interface org.refcodes.textual.TextAccessor.TextProvider
toString, toStrings
-
-
-
-
Method Detail
-
getOverwritingText
String getOverwritingText()
Retrieves the overwriting text from the overwriting text property.- Returns:
- The overwriting text stored by the overwriting text property.
-
setOverwritingText
void setOverwritingText(String aOverwritingText)
Sets the overwriting text for the overwriting text property.- Parameters:
aOverwritingText
- The overwriting text to be stored by the overwriting text property.
-
withOverwritingText
default OverwriteTextBuilder withOverwritingText(String aOverwritingText)
Sets the overwriting text for the overwriting text property.- Parameters:
aOverwritingText
- The overwriting text to be stored by the overwriting text property.- Returns:
- The builder for applying multiple build operations.
-
getOverwriteTextMode
OverwriteTextMode getOverwriteTextMode()
Retrieves the overwrite text mode from the overwrite text mode property.- Returns:
- The overwrite text mode stored by the overwrite text mode property.
-
setTextOverwriteMode
void setTextOverwriteMode(OverwriteTextMode aTextOverwriteMode)
Sets the overwrite text mode for the overwrite text mode property.- Parameters:
aTextOverwriteMode
- The overwrite text mode to be stored by the overwrite text mode property.
-
withOverwriteTextMode
default OverwriteTextBuilder withOverwriteTextMode(OverwriteTextMode aOverwriteTextMode)
Sets the overwrite text mode for the overwrite text mode property.- Parameters:
aOverwriteTextMode
- The overwrite text mode to be stored by the overwrite text mode property.- Returns:
- The builder for applying multiple build operations.
-
build
static OverwriteTextBuilder build()
This is a convenience method for easily instantiating the according builder.- Returns:
- an instance (using a default implementation) of this builder
-
-