net.sf.jaccumulator.texts

Interface MutableTextValue<VALUE extends MutableTextValue<VALUE>>

Type Parameters:

VALUE - this value type (used to facilitate operation chaining)

All Superinterfaces:

Appendable

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, MutableAccumulator<ACCUMULATOR>, MutablePrimitive<PRIMITIVE>, MutableText<TEXT>, Primitive<PRIMITIVE>, Text<TEXT>, TextValue<VALUE>

All Known Implementing Classes:

AbstractAccumulator, AbstractBooleanPrimitive, AbstractBytePrimitive, AbstractCharacterPrimitive, AbstractConstant, AbstractConstantAccumulator, AbstractDoublePrimitive, AbstractFloatPrimitive, AbstractIntegerPrimitive, AbstractLongPrimitive, AbstractModuloIntegerPrimitive, AbstractNumericPrimitive, AbstractPrimitive, AbstractPrimitiveWrapper, AbstractShortPrimitive, AbstractSimpleAccumulator, AbstractStickyTarget, AbstractTextPrimitive, AbstractUnlimitedDecimalPrimitive, AbstractUnlimitedIntegerPrimitive, BooleanArrayCursor, BooleanPrimitive, ByteArrayCursor, BytePrimitive, CharacterArrayCursor, CharacterPrimitive, Constant, ConstantAccumulator, DoublePrimitive, EnumerationPrimitive, FloatPrimitive, GaussianRandomPrimitive, IntegerPrimitive, LongPrimitive, Milliseconds, ModuloIntegerPrimitive, Nanoseconds, RandomPrimitive, ShortPrimitive, SimpleAccumulator, TextPrimitive, UnlimitedDecimalPrimitive, UnlimitedIntegerPrimitive, Variant

public interface MutableTextValue<VALUE extends MutableTextValue<VALUE>>
extends Appendable

A changeable text property value

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
VALUE	append(boolean aValue)
VALUE	append(char aValue)
VALUE	append(char[] content)
VALUE	append(char[] content, int contentIndex)
VALUE	append(char[] content, int contentIndex, int contentLength)
VALUE	append(CharSequence content)
VALUE	append(CharSequence content, int contentStartIndex)
VALUE	append(CharSequence content, int contentStartIndex, int contentEndIndexPlusOne)
VALUE	append(double aValue)
VALUE	append(float aValue)
VALUE	append(int aValue)
VALUE	append(long aValue)
VALUE	append(Object aValue)
VALUE	append(StringBuffer sb)
VALUE	appendCodePoint(int codePoint)
void	clear() Same as Collection.clear().
VALUE	clearText() Clear all characters from this primitive and re-interpret/re-set
VALUE	delete(int start, int end)
VALUE	deleteCharAt(int anIndex)
VALUE	insert(int anIndex, boolean aValue)
VALUE	insert(int anIndex, char aValue)
VALUE	insert(int anIndex, char[] content)
VALUE	insert(int targetIndex, char[] content, int contentIndex, int contentLength)
VALUE	insert(int anIndex, CharSequence content)
VALUE	insert(int targetIndex, CharSequence content, int contentIndex)
VALUE	insert(int targetIndex, CharSequence content, int contentStartIndex, int contentEndIndexPlusOne)
VALUE	insert(int anIndex, double aValue)
VALUE	insert(int anIndex, float aValue)
VALUE	insert(int anIndex, int aValue)
VALUE	insert(int anIndex, long aValue)
VALUE	insert(int anIndex, Object aValue)
VALUE	lowerCase() For text-based objects, convert all characters in the text to lower case.
VALUE	prepend(boolean aValue)
VALUE	prepend(char aValue)
VALUE	prepend(char[] content)
VALUE	prepend(char[] content, int contentIndex)
VALUE	prepend(char[] content, int contentIndex, int contentLength)
VALUE	prepend(CharSequence content)
VALUE	prepend(CharSequence content, int contentIndex)
VALUE	prepend(CharSequence content, int contentStartIndex, int contentEndIndexPlusOne)
VALUE	prepend(double aValue)
VALUE	prepend(float aValue)
VALUE	prepend(int aValue)
VALUE	prepend(long aValue)
VALUE	prepend(Object aValue)
VALUE	replace(CharSequence target, CharSequence replacement)
VALUE	replace(int start, int end, String str)
VALUE	replaceAll(String regex, String replacement)
VALUE	replaceCharacter(char oldChar, char newChar)
VALUE	replaceFirst(String regex, String replacement)
VALUE	reverse()
VALUE	setCharAt(int index, char ch)
VALUE	setLength(int newLength)
VALUE	setText(CharSequence content) Set this property to the specified text value and answer this object (facilitates chaining)
String	textPostDecrement() Decrement the real value of this text then return the original text prior to decrementing
String	textPostIncrement() Increment the real value of this text then return the original text prior to incrementing
VALUE	titleCase() For text-based objects, convert all characters in the text to title case.
VALUE	trim() Remove both leading and trailing whitespace
VALUE	upperCase() For text-based objects, convert all characters in the text to upper case.

Method Detail

append

VALUE append(boolean aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(char aValue)
                                             throws UnsupportedOperationException

Specified by:

append in interface Appendable

Throws:

UnsupportedOperationException

append

VALUE append(char[] content)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(char[] content,
           int contentIndex)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(char[] content,
           int contentIndex,
           int contentLength)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(CharSequence content)
                                             throws UnsupportedOperationException

Specified by:

append in interface Appendable

Throws:

UnsupportedOperationException

append

VALUE append(CharSequence content,
           int contentStartIndex)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(CharSequence content,
           int contentStartIndex,
           int contentEndIndexPlusOne)
                                             throws UnsupportedOperationException

Specified by:

append in interface Appendable

Throws:

UnsupportedOperationException

append

VALUE append(double aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(float aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(int aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(long aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(Object aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

append

VALUE append(StringBuffer sb)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

appendCodePoint

VALUE appendCodePoint(int codePoint)
                                                      throws UnsupportedOperationException

Throws:

UnsupportedOperationException

clear

void clear()
           throws UnsupportedOperationException

Same as Collection.clear(). So as to maintain compatibility, this function will not return the customary reference back to this primitive. In text primitives, this function will clear the current text contents

Throws:

UnsupportedOperationException - if this text cannot be cleared

See Also:

clearText();, Collection.clear(), MutableAlgebraicStructure.clearContents()

clearText

VALUE clearText()
                                                throws UnsupportedOperationException

Clear all characters from this primitive and re-interpret/re-set

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's text cannot be changed

See Also:

clear();, Collection.clear(), MutableAlgebraicStructure.clearContents()

delete

VALUE delete(int start,
           int end)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

deleteCharAt

VALUE deleteCharAt(int anIndex)
                                                   throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           boolean aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           char aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           char[] content)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int targetIndex,
           char[] content,
           int contentIndex,
           int contentLength)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           CharSequence content)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int targetIndex,
           CharSequence content,
           int contentIndex)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int targetIndex,
           CharSequence content,
           int contentStartIndex,
           int contentEndIndexPlusOne)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           double aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           float aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           int aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           long aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

insert

VALUE insert(int anIndex,
           Object aValue)
                                             throws UnsupportedOperationException

Throws:

UnsupportedOperationException

lowerCase

VALUE lowerCase()

For text-based objects, convert all characters in the text to lower case. For numeric objects, convert their character (BMP) or integer value (Unicode) to lower case, depending on the object's precision level

Returns:

this object (facilitates operation chaining)

prepend

VALUE prepend(boolean aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(char aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(char[] content)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(char[] content,
            int contentIndex)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(char[] content,
            int contentIndex,
            int contentLength)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(CharSequence content)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(CharSequence content,
            int contentIndex)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(CharSequence content,
            int contentStartIndex,
            int contentEndIndexPlusOne)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(double aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(float aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(int aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(long aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

prepend

VALUE prepend(Object aValue)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

replace

VALUE replace(CharSequence target,
            CharSequence replacement)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

replace

VALUE replace(int start,
            int end,
            String str)
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

replaceAll

VALUE replaceAll(String regex,
               String replacement)
                                                 throws UnsupportedOperationException

Throws:

UnsupportedOperationException

replaceCharacter

VALUE replaceCharacter(char oldChar,
                     char newChar)
                                                       throws UnsupportedOperationException

Throws:

UnsupportedOperationException

replaceFirst

VALUE replaceFirst(String regex,
                 String replacement)
                                                   throws UnsupportedOperationException

Throws:

UnsupportedOperationException

reverse

VALUE reverse()
                                              throws UnsupportedOperationException

Throws:

UnsupportedOperationException

setCharAt

VALUE setCharAt(int index,
              char ch)
                                                throws UnsupportedOperationException

Throws:

UnsupportedOperationException

setLength

VALUE setLength(int newLength)
                                                throws UnsupportedOperationException

Throws:

UnsupportedOperationException

setText

VALUE setText(CharSequence content)
                                              throws UnsupportedOperationException,
                                                     IllegalArgumentException,
                                                     NullPointerException

Set this property to the specified text value and answer this object (facilitates chaining)

Parameters:

content - a text value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the specified value was incommensurate with this object's specification

NullPointerException - a null value was provided and this implementation does not accept null values

textPostDecrement

String textPostDecrement()
                         throws UnsupportedOperationException,
                                ArithmeticException,
                                IllegalArgumentException

Decrement the real value of this text then return the original text prior to decrementing

Returns:

the original value of this text

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

textPostIncrement

String textPostIncrement()
                         throws UnsupportedOperationException,
                                ArithmeticException,
                                IllegalArgumentException

Increment the real value of this text then return the original text prior to incrementing

Returns:

the original value of this text

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

titleCase

VALUE titleCase()

For text-based objects, convert all characters in the text to title case. For numeric objects, convert their character (BMP) or integer value (Unicode) to title case, depending on the object's precision level

Returns:

this object (facilitates operation chaining)

trim

VALUE trim()

Remove both leading and trailing whitespace

Returns:

this object (facilitates operation chaining)

upperCase

VALUE upperCase()

For text-based objects, convert all characters in the text to upper case. For numeric objects, convert their character (BMP) or integer value (Unicode) to upper case, depending on the object's precision level

Returns:

this object (facilitates operation chaining)