PRIMITIVE
- this primitive type (used to facilitate operation chaining on write
operations)public abstract class AbstractConstant<PRIMITIVE extends Primitive<PRIMITIVE>> extends AbstractNumericPrimitive<PRIMITIVE>
primitive
whose modification functions are shunted
and which will produce UnsupportedOperationExceptions
upon accessNaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI
Constructor and Description |
---|
AbstractConstant() |
AbstractConstant(Domain aDomain,
NumericPrecision aPrecision) |
AbstractConstant(NumericPrecision aPrecision) |
Modifier and Type | Method and Description |
---|---|
PRIMITIVE |
append(boolean aValue) |
PRIMITIVE |
append(char c) |
PRIMITIVE |
append(char[] content) |
PRIMITIVE |
append(char[] content,
int contentIndex,
int contentLength) |
PRIMITIVE |
append(CharSequence s) |
PRIMITIVE |
append(CharSequence s,
int start,
int end) |
PRIMITIVE |
append(double aValue) |
PRIMITIVE |
append(float aValue) |
PRIMITIVE |
append(int aValue) |
PRIMITIVE |
append(long aValue) |
PRIMITIVE |
append(Object aValue) |
PRIMITIVE |
append(StringBuffer sb) |
PRIMITIVE |
appendCodePoint(int codePoint) |
boolean |
booleanPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
boolean |
booleanPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
byte |
bytePostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
byte |
bytePostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
char |
charPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
char |
charPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
void |
clear()
Same as
Collection.clear() . |
PRIMITIVE |
copy()
Produce a replica of this object
|
PRIMITIVE |
cube()
Replace the current value with the cube of itself
|
PRIMITIVE |
decrement()
Replace the current value with the current value minus unity (one)
|
PRIMITIVE |
delete(int start,
int end) |
PRIMITIVE |
deleteCharAt(int anIndex) |
double |
doublePostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
double |
doublePostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
float |
floatPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
float |
floatPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
ConcurrencyStrategy |
getConcurrency() |
PRIMITIVE |
increment()
Replace the current value with the current value plus unity (one)
|
<P extends Primitive<?>> |
inducePostDecrement(P aTarget)
Decrement the value of this Primitive then induce its original value into
the specified target
|
<R extends Real<?>> |
inducePostDecrement(R aTarget)
Decrement the value of this real then induce its original value into
the specified target
|
<S extends Scalar<?>> |
inducePostDecrement(S aTarget)
Decrement the value of this scalar then induce its original value into
the specified target
|
<P extends Primitive<?>> |
inducePostIncrement(P aTarget)
Increment the value of this Primitive then induce its original value into
the specified target
|
<R extends Real<?>> |
inducePostIncrement(R aTarget)
Increment the value of this real then induce its original value into
the specified target
|
<S extends Scalar<?>> |
inducePostIncrement(S aTarget)
Increment the value of this scalar then induce its original value into
the specified target
|
<R extends Real<?>> |
induceRealMaximum(R aTarget)
Induce the maximum domain value into the target
|
<R extends Real<?>> |
induceRealMinimum(R aTarget)
Induce the minimum domain value into the target
|
<R extends Real<?>> |
induceRealValue(R aTarget)
Induce the current value of this real into the specified target
|
<S extends Scalar<?>> |
induceScalarMaximum(S aTarget)
Induce the maximum domain value into the target
|
<S extends Scalar<?>> |
induceScalarMinimum(S aTarget)
Induce the minimum domain value into the target
|
<S extends Scalar<?>> |
induceScalarValue(S aTarget)
Induce the current value of this scalar into the specified target
|
PRIMITIVE |
insert(int anIndex,
boolean aValue) |
PRIMITIVE |
insert(int anIndex,
char aValue) |
PRIMITIVE |
insert(int anIndex,
char[] content) |
PRIMITIVE |
insert(int targetIndex,
char[] content,
int contentIndex,
int contentLength) |
PRIMITIVE |
insert(int anIndex,
CharSequence content) |
PRIMITIVE |
insert(int targetIndex,
CharSequence content,
int contentIndex) |
PRIMITIVE |
insert(int targetIndex,
CharSequence content,
int contentStartIndex,
int contentEndIndexPlusOne) |
PRIMITIVE |
insert(int anIndex,
double aValue) |
PRIMITIVE |
insert(int anIndex,
float aValue) |
PRIMITIVE |
insert(int anIndex,
int aValue) |
PRIMITIVE |
insert(int anIndex,
long aValue) |
PRIMITIVE |
insert(int anIndex,
Object aValue) |
int |
intPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
int |
intPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
PRIMITIVE |
inverse()
Replace the current value its multiplicative inverse (
1/x ) |
boolean |
isConfigurable()
|
boolean |
isDigit()
Determine if this
char -width or int -width
character is a digit within Unicode |
boolean |
isElastic()
Scalar representations are hardware-driven and not scalable.
|
boolean |
isExpandable()
Scalar representations are hardware-driven and not scalable.
|
boolean |
isIdentifierIgnorable()
Determine if this
char -width or int -width
character ignorable character in a Java identifier or a Unicode
identifier |
boolean |
isISOControl()
Determine if this
char -width or int -width
character is an ISO control character within Unicode |
boolean |
isJavaIdentifierPart()
Determine if this
char -width or int -width
character is a part of a Java identifier as other than the first
character |
boolean |
isJavaIdentifierStart()
Determine if this
char -width or int -width
character is permissible as the first character in a Java identifier |
boolean |
isLetter()
Determine if this
char -width or int -width
character is a letter within Unicode |
boolean |
isLetterOrDigit()
Determine if this
char -width or int -width
character is a letter or digit within Unicode |
boolean |
isLowerCase()
Determine if this
char -width or int -width
character is a lower case character within Unicode |
boolean |
isMirrored()
Determine if this
char -width or int -width
character is "mirrored" within Unicode |
boolean |
isModulo()
Answer
true if this value represents the magnitude of a vector
into a modulo set, or finite ring. |
boolean |
isReal()
Answer
true if this value represents the magnitude of a vector
into the set of real numbers. |
boolean |
isReducible()
Scalar representations are hardware-driven and not scalable.
|
boolean |
isText() |
boolean |
isTitleCase()
Determine if this
char -width or int -width
character is a title case character within Unicode |
boolean |
isUnicode()
Determine if this
char -width or int -width
character is defined within Unicode |
boolean |
isUnicodeIdentifierPart()
Determine if this
char -width or int -width
character is a part of a Unicode identifier as other than the first
character |
boolean |
isUnicodeIdentifierStart()
Determine if this
char -width or int -width
character is permissible as the first character in a Unicode identifier |
boolean |
isUpperCase()
Determine if this
char -width or int -width
character is an upper case character within Unicode |
boolean |
isWhitespace()
Determine if this
char -width or int -width
character is whitespace within Unicode |
long |
longPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
long |
longPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
PRIMITIVE |
lowerCase()
For text-based objects, convert all characters in the text to lower case.
|
PRIMITIVE |
negate()
Replace the current value with the additive inverse (sign negation) of
itself, that is transform it into a number that when added to the
original yields zero.
|
PRIMITIVE |
not()
Replace the current integral binary vector with its one's
complement.
|
PRIMITIVE |
replace(CharSequence target,
CharSequence replacement) |
PRIMITIVE |
replace(int start,
int end,
String str) |
PRIMITIVE |
replaceAll(String regex,
String replacement) |
PRIMITIVE |
replaceCharacter(char oldChar,
char newChar) |
PRIMITIVE |
replaceFirst(String regex,
String replacement) |
PRIMITIVE |
reverse() |
PRIMITIVE |
round(RoundingStrategy aRoundingStrategy)
Round the current value using the specified rounding
strategy |
PRIMITIVE |
setCharAt(int index,
char ch) |
<E extends Enum<E>> |
setEnumeration(E aValue)
Match the value of this object with the identity of the specified
enumeration instance, then answer this object (facilitates
chaining) |
PRIMITIVE |
setLength(int newLength) |
PRIMITIVE |
setMaximum()
Replace the current value with maximum value available for the
implementation's numeric
precision . |
PRIMITIVE |
setMinimum()
Replace the current value with minimum value available for the
implementation's numeric
precision . |
PRIMITIVE |
setNegativeInfinity()
Replace the current value with a representation of negative infinity, if
available, otherwise replace with the implementation's
minimum value |
PRIMITIVE |
setPositiveInfinity()
Replace the current value with a representation of positive infinity, if
available, otherwise replace with the implementation's
maximum value |
PRIMITIVE |
setReal(BigDecimal aValue)
Set this property to the specified unlimited
decimal
value and answer this object (facilitates chaining) |
PRIMITIVE |
setReal(BigInteger aValue)
Set this property to the specified unlimited
integer
value and answer this object (facilitates chaining) |
PRIMITIVE |
setScalar(boolean aValue)
Set this property to the specified
boolean value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(byte aValue)
Set this property to the specified
byte value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(char aValue)
Set this property to the specified
char value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(double aValue)
Set this property to the specified
double value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(float aValue)
Set this property to the specified
float value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(int aValue)
Set this property to the specified
int value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(long aValue)
Set this property to the specified
long value and answer this
object (facilitates chaining) |
PRIMITIVE |
setScalar(short aValue)
Set this property to the specified
short value and answer this
object (facilitates chaining) |
PRIMITIVE |
setText(CharSequence content)
Set this property to the specified
text value and answer
this object (facilitates chaining) |
PRIMITIVE |
shiftLeft(int count)
Attempt to shift the elements of this tuple to the "left" the specified
number of ordinal positions.
|
PRIMITIVE |
shiftRight(int count)
Attempt to shift the elements of this tuple to the "right" the specified
number of ordinal positions.
|
PRIMITIVE |
shiftRightExtendZero(int count)
Attempt to shift the elements of this tuple to the "right" the specified
number of ordinal positions without sign extension.
|
short |
shortPostDecrement()
Decrement the scalar value of this object then return the original value
prior to decrementing
|
short |
shortPostIncrement()
Increment the scalar value of this object then return the original value
prior to incrementing
|
PRIMITIVE |
square()
Replace the current value with the square of itself
|
PRIMITIVE |
swapPrimitives(Primitive<?> aPrimitive)
Swap the value of this primitive for the specified one and set the
specified primitive's value to the current value of this primitive
|
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
|
PRIMITIVE |
titleCase()
For text-based objects, convert all characters in the text to
title case. |
int |
toCodePoint()
Represent the value of this object as a code point
|
PRIMITIVE |
trim()
Remove both leading and trailing
whitespace |
BigDecimal |
unlimitedDecimalPostDecrement()
Decrement the real value of this object then return the original value
prior to decrementing
|
BigDecimal |
unlimitedDecimalPostIncrement()
Increment the real value of this object then return the original value
prior to incrementing
|
BigInteger |
unlimitedIntegerPostDecrement()
Decrement the real value of this object then return the original value
prior to decrementing
|
BigInteger |
unlimitedIntegerPostIncrement()
Increment the real value of this object then return the original value
prior to incrementing
|
PRIMITIVE |
upperCase()
For text-based objects, convert all characters in the text to upper case.
|
append, append, charAt, clearContents, clearText, codePointAt, codePointBefore, codePointCount, compareTo, compareToPrimitive, copyUsingText, equals, getStructureStrategy, indexOfText, indexOfText, inducePrimitiveValue, induceTextValue, isEmpty, isEqualToPrimitive, isEqualToText, isGreaterOrEqualToPrimitive, isGreaterOrEqualToText, isGreaterThanPrimitive, isGreaterThanText, isLessOrEqualToPrimitive, isLessOrEqualToText, isLessThanPrimitive, isLessThanText, isNotEqualToPrimitive, isNotEqualToText, length, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, setBoolean, setCharacter, setNumber, setPrimitive, setReal, subSequence, substring, substring, toPrimitive, toPrimitive
andOfPrimitive, angleWithPrimitive, compareToText, differenceOfPrimitive, hypotenuseWithPrimitive, inducePrimitiveMaximum, inducePrimitiveMinimum, induceTextSize, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, toPrimitive, xorOfPrimitive
and, andOfNumber, andOfReal, angleWithReal, compareToNumber, compareToReal, compareToReal, compareToReal, difference, difference, differenceOfNumber, differenceOfReal, gcd, gcdOfNumber, gcdOfReal, hypotenuseWithReal, induceRealSize, isEqual, isEqual, isEqualToNumber, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToReal, isGreaterThanNumber, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToReal, isLessThanNumber, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToReal, mod, mod, modOfNumber, modOfReal, or, orOfNumber, orOfReal, powerOfReal, product, product, productOfNumber, productOfReal, quotient, quotient, quotientOfNumber, quotientOfReal, sum, sum, sumOfNumber, sumOfReal, toReal, unlimitedIntegerModularInverse, xor, xorOfNumber, xorOfReal
absoluteValue, and, and, and, and, and, and, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, assertDomain, assertPrecision, base10Log, boundsCheck, byteMaskAt, byteNotMaskAt, byteValue, ceiling, charMaskAt, charNotMaskAt, charValue, clearByteBitAt, clearCharBitAt, clearDoubleBitAt, clearFloatBitAt, clearIntBitAt, clearLongBitAt, clearShortBitAt, clearUnlimitedDecimalBitAt, clearUnlimitedIntegerBitAt, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, cosine, cubeRoot, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfScalar, divideByZero, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfScalar, getBooleanBitAt, getByteBitAt, getCharBitAt, getDomain, getDoubleBitAt, getFloatBitAt, getIntBitAt, getLongBitAt, getPrecision, getShortBitAt, getUnlimitedDecimalBitAt, getUnlimitedIntegerBitAt, halfDown, halfEven, halfUp, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, indexOutOfBoundsAt, induceScalarSize, intGCD, intMaskAt, intModularInverse, intModularQuotient, intNotMaskAt, intValue, invalidate, isAlphabetic, isBmpCodePoint, isCountable, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToScalar, isFalse, isFinite, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToScalar, isGreaterThanScalar, isHighSurrogate, isIdeographic, isImaginary, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToScalar, isLessThanScalar, isLowSurrogate, isMutable, isNegativeFinite, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToScalar, isOrdered, isPositiveFinite, isSupplementaryCodePoint, isSurrogate, isTrue, isUnique, isValid, isValidCodePoint, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longSize, longValue, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, or, or, or, or, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfScalar, promoteTo, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfScalar, radians, random, setByteBitAt, setCharBitAt, setDoubleBitAt, setE, setFalse, setFloatBitAt, setIntBitAt, setLongBitAt, setPi, setScalar, setShortBitAt, setTrue, setUnity, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, setZero, shortMaskAt, shortNotMaskAt, shortValue, signum, sine, size, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfScalar, tangent, toBoolean, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toCharacter, toEnumeration, toScalar, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xor, xor, xor, xor, xor, xor, xorOfScalar
byteValue, doubleValue, floatValue, intValue, longValue, shortValue
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
copyUsingPrimitive
compareToReal, compareToReal, compareToReal, isEqual, isEqual, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToReal, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToReal, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToReal
compareToNumber, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToNumber, isEqualToScalar, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToScalar, isGreaterThanNumber, isGreaterThanScalar, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToScalar, isLessThanNumber, isLessThanScalar, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToScalar, isTrue, toBoolean, toCharacter, toEnumeration, toNumber
hashCode, toString
isFinite, isImaginary, isInfinity, isInvalid, isMaximum, isMinimum, isNegative, isNegativeFinite, isNegativeInfinity, isPositive, isPositiveFinite, isPositiveInfinity, isUnity, isValid, isZero, signum
isAlphabetic, isBmpCodePoint, isHighSurrogate, isIdeographic, isLowSurrogate, isSupplementaryCodePoint, isSurrogate, isValidCodePoint
booleanValue
byteValue
charValue
doubleValue
floatValue
intValue
longValue
shortValue
getPrecision
induceRealSize
induceScalarSize
getDomain, longSize, size
isCountable, isOrdered, isUnique
copyUsing, copyUsing, copyUsingReal, toReal
copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsing, copyUsingScalar, toScalar
and, andOfReal, angleWithReal, difference, difference, differenceOfReal, gcd, gcdOfReal, hypotenuseWithReal, mod, mod, modOfReal, or, orOfReal, powerOfReal, product, product, productOfReal, quotient, quotient, quotientOfReal, sum, sum, sumOfReal, xor, xorOfReal
absoluteValue, and, and, and, and, and, and, andOfNumber, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cubeRoot, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfNumber, differenceOfScalar, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfNumber, gcdOfScalar, halfDown, halfEven, halfUp, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, invalidate, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfNumber, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, or, or, or, or, or, or, orOfNumber, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfNumber, productOfScalar, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfNumber, quotientOfScalar, radians, random, setE, setPi, setScalar, setUnity, setZero, sine, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfNumber, sumOfScalar, tangent, up, xor, xor, xor, xor, xor, xor, xorOfNumber, xorOfScalar
setFalse, setTrue
assertPrecision, promoteTo
assertDomain
toUnlimitedInteger
toUnlimitedDecimal
toString
public AbstractConstant()
public AbstractConstant(Domain aDomain, NumericPrecision aPrecision)
public AbstractConstant(NumericPrecision aPrecision)
public final PRIMITIVE append(boolean aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(char c) throws UnsupportedOperationException
append
in interface Appendable
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(char[] content) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(char[] content, int contentIndex, int contentLength) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(CharSequence s) throws UnsupportedOperationException
append
in interface Appendable
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(CharSequence s, int start, int end) throws UnsupportedOperationException
append
in interface Appendable
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(double aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(float aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(int aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(long aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(Object aValue) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE append(StringBuffer sb) throws UnsupportedOperationException
append
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
append
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE appendCodePoint(int codePoint) throws UnsupportedOperationException
appendCodePoint
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
appendCodePoint
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final boolean booleanPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableBooleanValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final boolean booleanPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableBooleanValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final byte bytePostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableByteValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final byte bytePostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableByteValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final char charPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableCharacterValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final char charPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableCharacterValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final void clear()
MutableAlgebraicStructure
Collection.clear()
. So as to maintain compatibility, this
function will not return the customary reference back to this structure.clear
in interface MutableAlgebraicStructure<PRIMITIVE extends Primitive<PRIMITIVE>>
clear
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
clear
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
MutableAlgebraicStructure.clearContents()
,
Collection.clear()
,
MutableTextValue.clearText();
public final PRIMITIVE copy()
Replicator
public final PRIMITIVE cube() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE decrement() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE delete(int start, int end) throws UnsupportedOperationException
delete
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
delete
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE deleteCharAt(int anIndex) throws UnsupportedOperationException
deleteCharAt
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
deleteCharAt
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final double doublePostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableDoubleValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final double doublePostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableDoubleValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final float floatPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableFloatValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final float floatPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableFloatValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final ConcurrencyStrategy getConcurrency()
public final PRIMITIVE increment() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final <P extends Primitive<?>> P inducePostDecrement(P aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
PrimitiveInductor
inducePostDecrement
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePostDecrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
P
- the target typeaTarget
- a target into which the current value of this Primitive will be
induced, prior to decrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target Primitive cannot be changedIllegalStateException
- this target Primitive cannot be changed at this timepublic final <R extends Real<?>> R inducePostDecrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
inducePostDecrement
in interface RealInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePostDecrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- a target into which the current value of this real will be
induced, prior to decrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <S extends Scalar<?>> S inducePostDecrement(S aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
ScalarInductor
S
- the target typeaTarget
- a target into which the current value of this scalar will be
induced, prior to decrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <P extends Primitive<?>> P inducePostIncrement(P aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
PrimitiveInductor
inducePostIncrement
in interface PrimitiveInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePostIncrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
P
- the target typeaTarget
- a target into which the current value of this Primitive will be
induced, prior to incrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target Primitive cannot be changedIllegalStateException
- this target Primitive cannot be changed at this timepublic final <R extends Real<?>> R inducePostIncrement(R aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
RealInductor
inducePostIncrement
in interface RealInductor<PRIMITIVE extends Primitive<PRIMITIVE>>
inducePostIncrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
R
- the target typeaTarget
- a target into which the current value of this real will be
induced, prior to incrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic final <S extends Scalar<?>> S inducePostIncrement(S aTarget) throws NullPointerException, NoSuchElementException, UnsupportedOperationException, IllegalStateException
ScalarInductor
S
- the target typeaTarget
- a target into which the current value of this scalar will be
induced, prior to incrementingNullPointerException
- a null
value was provided when none was expectedNoSuchElementException
- an expected parameter was not found in the parameter sourceUnsupportedOperationException
- this target primitive cannot be changedIllegalStateException
- this target primitive cannot be changed at this timepublic <R extends Real<?>> R induceRealMaximum(R aTarget)
SealedRealDomain
R
- the target typeaTarget
- a target into which this domain's maximum value will be inducedpublic <R extends Real<?>> R induceRealMinimum(R aTarget)
SealedRealDomain
R
- the target typeaTarget
- a target into which this domain's minimum value will be inducedpublic <R extends Real<?>> R induceRealValue(R aTarget)
RealInductor
R
- the target typeaTarget
- a target into which the current value of this real will be
inducedpublic <S extends Scalar<?>> S induceScalarMaximum(S aTarget)
SealedScalarDomain
S
- the target typeaTarget
- a target into which this domain's maximum value will be inducedpublic <S extends Scalar<?>> S induceScalarMinimum(S aTarget)
SealedScalarDomain
S
- the target typeaTarget
- a target into which this domain's minimum value will be inducedpublic <S extends Scalar<?>> S induceScalarValue(S aTarget)
ScalarInductor
S
- the target typeaTarget
- a target into which the current value of this scalar will be
inducedpublic final PRIMITIVE insert(int anIndex, boolean aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, char aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, char[] content) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int targetIndex, char[] content, int contentIndex, int contentLength) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, CharSequence content) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int targetIndex, CharSequence content, int contentIndex) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int targetIndex, CharSequence content, int contentStartIndex, int contentEndIndexPlusOne) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, double aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, float aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, int aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, long aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE insert(int anIndex, Object aValue) throws UnsupportedOperationException
insert
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
insert
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final int intPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final int intPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE inverse() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
1/x
)UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final boolean isConfigurable()
StructureProperties
true
if the implementation of this object can be changed.expanded
, or reduced
, or has replaceable
components. Configurable structures are necessarily
mutable
; in fact, "configurability" can be
used as a strict definition of mutability. This predicate however
overrides #isMutable
in the respect that, for some types of
objects such as Variants
, mutability can be changed by
switching from a non-mutable implementation to a mutable one (e.g., via
assertPrecision
).isConfigurable
in interface StructureProperties
isConfigurable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the implementation of this object can be changedpublic final boolean isDigit()
CharacterProperties
char
-width or int
-width
character is a digit within UnicodeisDigit
in interface CharacterProperties
isDigit
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a digit in UnicodeCharacter.isDigit(char)
,
Character.isDigit(int)
public final boolean isElastic()
isElastic
in interface StructureProperties
isElastic
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure can be either
reduced
or expanded
public final boolean isExpandable()
isExpandable
in interface StructureProperties
isExpandable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure can be expanded via element
insertionpublic final boolean isIdentifierIgnorable()
CharacterProperties
char
-width or int
-width
character ignorable character in a Java identifier or a Unicode
identifierisIdentifierIgnorable
in interface CharacterProperties
isIdentifierIgnorable
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, ignorable character in a Java
identifier or a Unicode identifier as other than the first
characterCharacter.isIdentifierIgnorable(char)
,
Character.isIdentifierIgnorable(int)
public final boolean isISOControl()
CharacterProperties
char
-width or int
-width
character is an ISO control character within UnicodeisISOControl
in interface CharacterProperties
isISOControl
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is an ISO control character in
UnicodeCharacter.isISOControl(char)
,
Character.isISOControl(int)
public final boolean isJavaIdentifierPart()
CharacterProperties
char
-width or int
-width
character is a part of a Java identifier as other than the first
characterisJavaIdentifierPart
in interface CharacterProperties
isJavaIdentifierPart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a part of a Java identifier as
other than the first characterCharacter.isJavaIdentifierPart(char)
,
Character.isJavaIdentifierPart(int)
public final boolean isJavaIdentifierStart()
CharacterProperties
char
-width or int
-width
character is permissible as the first character in a Java identifierisJavaIdentifierStart
in interface CharacterProperties
isJavaIdentifierStart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is permissible as the first
character in a Java identifierCharacter.isJavaIdentifierStart(char)
,
Character.isJavaIdentifierStart(int)
public final boolean isLetter()
CharacterProperties
char
-width or int
-width
character is a letter within UnicodeisLetter
in interface CharacterProperties
isLetter
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a letter in UnicodeCharacter.isLetter(char)
,
Character.isLetter(int)
public final boolean isLetterOrDigit()
CharacterProperties
char
-width or int
-width
character is a letter or digit within UnicodeisLetterOrDigit
in interface CharacterProperties
isLetterOrDigit
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a letter or digit in UnicodeCharacter.isLetterOrDigit(char)
,
Character.isLetterOrDigit(int)
public final boolean isLowerCase()
CharacterProperties
char
-width or int
-width
character is a lower case character within UnicodeisLowerCase
in interface CharacterProperties
isLowerCase
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a lower case character in
UnicodeCharacter.isLowerCase(char)
,
Character.isLowerCase(int)
public final boolean isMirrored()
CharacterProperties
char
-width or int
-width
character is "mirrored" within UnicodeisMirrored
in interface CharacterProperties
isMirrored
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is "mirrored" in UnicodeCharacter.isMirrored(char)
,
Character.isMirrored(int)
public final boolean isModulo()
NumericProperties
true
if this value represents the magnitude of a vector
into a modulo set, or finite ring. This is not the same as testing
whether this object's implementation resembles the specification for the
MODULO
domain, since that is too specific to
implementation machinery. Modulo values, for instance can either be
real
or imaginary
.true
if this value represents the magnitude of a vector
into a modulo set, or finite ringpublic final boolean isReal()
NumericProperties
true
if this value represents the magnitude of a vector
into the set of real numbers. This is not the same as testing whether
this object's implementation resembles the specification for the
REAL
domain, since that is too specific to
implementation machinery. This more general test also includes real
modulo
values in its specification.true
if this value represents the magnitude of a vector
into the set of real numberspublic final boolean isReducible()
isReducible
in interface StructureProperties
isReducible
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this structure, in principle, can be
reduced via element removalpublic boolean isText()
isText
in interface TextProperties
isText
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if this object utilizes a text-based implementationpublic final boolean isTitleCase()
CharacterProperties
char
-width or int
-width
character is a title case character within UnicodeisTitleCase
in interface CharacterProperties
isTitleCase
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a title case character in
UnicodeCharacter.isTitleCase(char)
,
Character.isTitleCase(int)
public final int toCodePoint()
SealedScalar
toCodePoint
in interface SealedScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
toCodePoint
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
public final boolean isUnicode()
CharacterProperties
char
-width or int
-width
character is defined within UnicodeisUnicode
in interface CharacterProperties
isUnicode
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is defined in UnicodeCharacter.isDefined(char)
,
Character.isDefined(int)
public final boolean isUnicodeIdentifierPart()
CharacterProperties
char
-width or int
-width
character is a part of a Unicode identifier as other than the first
characterisUnicodeIdentifierPart
in interface CharacterProperties
isUnicodeIdentifierPart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is a part of a Unicode identifier
as other than the first characterCharacter.isUnicodeIdentifierPart(char)
,
Character.isUnicodeIdentifierPart(int)
public final boolean isUnicodeIdentifierStart()
CharacterProperties
char
-width or int
-width
character is permissible as the first character in a Unicode identifierisUnicodeIdentifierStart
in interface CharacterProperties
isUnicodeIdentifierStart
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is permissible as the first
character in a Unicode identifierCharacter.isUnicodeIdentifierStart(char)
,
Character.isUnicodeIdentifierStart(int)
public final boolean isUpperCase()
CharacterProperties
char
-width or int
-width
character is an upper case character within UnicodeisUpperCase
in interface CharacterProperties
isUpperCase
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is an upper case character in
UnicodeCharacter.isUpperCase(char)
,
Character.isUpperCase(int)
public final boolean isWhitespace()
CharacterProperties
char
-width or int
-width
character is whitespace within UnicodeisWhitespace
in interface CharacterProperties
isWhitespace
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
true
if the scalar value of this object, as appropriate
for this objects's precision, is whitespace in UnicodeCharacter.isWhitespace(char)
,
Character.isWhitespace(int)
public final long longPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableLongValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final long longPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableLongValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE lowerCase()
MutableTextValue
lowerCase
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
lowerCase
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final PRIMITIVE negate() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
boolean
and char
values do not exist, these
implementations will simply fail silently.)UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this object (optional)IllegalArgumentException
- if the new value was incommensurate with this object's
specification (optional)public final PRIMITIVE not() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
double
, will be first
converted to unlimited integers
before their bits are
reversed.UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE replace(CharSequence target, CharSequence replacement)
replace
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
replace
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final PRIMITIVE replace(int start, int end, String str) throws UnsupportedOperationException
replace
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
replace
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE replaceAll(String regex, String replacement)
replaceAll
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
replaceAll
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final PRIMITIVE replaceCharacter(char oldChar, char newChar)
replaceCharacter
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
replaceCharacter
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final PRIMITIVE replaceFirst(String regex, String replacement)
replaceFirst
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
replaceFirst
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final PRIMITIVE reverse() throws UnsupportedOperationException
reverse
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
reverse
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE round(RoundingStrategy aRoundingStrategy) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableScalar
strategy
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectNullPointerException
public PRIMITIVE setCharAt(int index, char ch) throws UnsupportedOperationException
setCharAt
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
setCharAt
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final <E extends Enum<E>> PRIMITIVE setEnumeration(E aValue) throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException, NullPointerException
MutableScalar
enumeration
instance, then answer this object (facilitates
chaining)setEnumeration
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setEnumeration
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
aValue
- a system-supported enumeration
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setLength(int newLength) throws UnsupportedOperationException
setLength
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
setLength
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
public final PRIMITIVE setMaximum() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
precision
. Unlimited
values will be replaced with the maximum value available for the most
precise system scalar appropriate for the implementation, that is
unlimited integer
primitives will set
themselves to the maximum
long
value and
unlimited decimal
primitives will set
themselves to the maximum
double
value.UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE setMinimum() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
precision
. Unlimited
values will be replaced with the minimum value available for the most
precise system scalar appropriate for the implementation, that is
unlimited integer
primitives will set
themselves to the minimum
long
value and
unlimited decimal
primitives will set
themselves to the minimum
double
value.UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE setNegativeInfinity() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableScalar
minimum
valuesetNegativeInfinity
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setNegativeInfinity
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE setPositiveInfinity() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
maximum
valuesetPositiveInfinity
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
setPositiveInfinity
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setReal(BigDecimal aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableUnlimitedDecimalValue
decimal
value and answer this object (facilitates chaining)aValue
- an unlimited decimal
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setReal(BigInteger aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException, NullPointerException
MutableUnlimitedIntegerValue
integer
value and answer this object (facilitates chaining)aValue
- an unlimited integer
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectNullPointerException
- a null
value was provided though this object does not
accept null
valuespublic final PRIMITIVE setScalar(boolean aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableBooleanValue
boolean
value and answer this
object (facilitates chaining)aValue
- a boolean
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(byte aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableByteValue
byte
value and answer this
object (facilitates chaining)aValue
- a byte
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(char aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableCharacterValue
char
value and answer this
object (facilitates chaining)aValue
- a char
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(double aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableDoubleValue
double
value and answer this
object (facilitates chaining)aValue
- a double
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(float aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableFloatValue
float
value and answer this
object (facilitates chaining)aValue
- a float
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(int aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableIntegerValue
int
value and answer this
object (facilitates chaining)aValue
- an int
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(long aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableLongValue
long
value and answer this
object (facilitates chaining)aValue
- a long
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setScalar(short aValue) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableShortValue
short
value and answer this
object (facilitates chaining)aValue
- a short
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE setText(CharSequence content) throws UnsupportedOperationException, IllegalArgumentException, NullPointerException
MutableTextValue
text
value and answer
this object (facilitates chaining)setText
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
setText
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
content
- a text
valueUnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the specified value was incommensurate with this object's
specificationNullPointerException
- a null
value was provided and this implementation does
not accept null
valuespublic final PRIMITIVE shiftLeft(int count) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
<<
). In other
sequences, the specified number of default values will be prepended to
the beginning of the sequence, increasing the ordinal position of all
existing elements by the specified count.count
- the number of default values to be prepended to this sequenceUnsupportedOperationException
- if this object's value cannot be changed or if this structure is
not an algebraic tupleIllegalArgumentException
- if the specified value was incommensurate with this structure's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this structurepublic final PRIMITIVE shiftRight(int count) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
>>
operator). In other sequences, the specified number of values
will be removed from the beginning of the sequence, decreasing the
ordinal position of all remaining elements by the specified count.count
- the number of values to be removed from the beginning of this
sequenceUnsupportedOperationException
- if this object's value cannot be changed or if this structure is
not an algebraic tupleIllegalArgumentException
- if the specified value was incommensurate with this structure's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this structurepublic final PRIMITIVE shiftRightExtendZero(int count) throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
>>>
operator). In other
sequences, the specified number of values will be removed from the
beginning of the sequence, decreasing the ordinal position of all
remaining elements by the specified count.shiftRightExtendZero
in interface MutableScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
shiftRightExtendZero
in class AbstractScalar<PRIMITIVE extends Primitive<PRIMITIVE>>
count
- the number of values to be removed from the beginning of this
sequenceUnsupportedOperationException
- if this object's value cannot be changed or if this structure is
not an algebraic tupleIllegalArgumentException
- if the specified value was incommensurate with this structure's
specificationArithmeticException
- the numeric value provided was incompatible with with algebraic
interpretation of this structurepublic final short shortPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableShortValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final short shortPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableShortValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE square() throws UnsupportedOperationException, IllegalArgumentException, ArithmeticException
MutableScalar
UnsupportedOperationException
- if this object's value cannot be changedIllegalArgumentException
- if the new value was incommensurate with this object's
specificationArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectpublic final PRIMITIVE swapPrimitives(Primitive<?> aPrimitive)
Primitive
aPrimitive
- the primitive to swap withpublic final String textPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableTextValue
textPostDecrement
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
textPostDecrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final String textPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableTextValue
textPostIncrement
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
textPostIncrement
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE titleCase()
MutableTextValue
title
case. For numeric objects,
convert their character (BMP) or integer value (Unicode) to title case,
depending on the object's precision leveltitleCase
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
titleCase
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final PRIMITIVE trim()
MutableTextValue
whitespace
trim
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
trim
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
public final BigDecimal unlimitedDecimalPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedDecimalValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final BigDecimal unlimitedDecimalPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedDecimalValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final BigInteger unlimitedIntegerPostDecrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final BigInteger unlimitedIntegerPostIncrement() throws UnsupportedOperationException, ArithmeticException, IllegalArgumentException
MutableUnlimitedIntegerValue
UnsupportedOperationException
- if this object's value cannot be changedArithmeticException
- the new numeric value was incompatible with with algebraic
interpretation of this objectIllegalArgumentException
- if the new value was incommensurate with this object's
specificationpublic final PRIMITIVE upperCase()
MutableTextValue
upperCase
in interface MutableTextValue<PRIMITIVE extends Primitive<PRIMITIVE>>
upperCase
in class AbstractNumericPrimitive<PRIMITIVE extends Primitive<PRIMITIVE>>
Copyright © 2006-2012 Ware-Squared Software Development. All Rights Reserved.