java.io.Serializable
, PullEvent
, SequenceIterable
, GroundedValue
, Item
, ValueRepresentation
, ConversionResult
public final class DecimalValue extends NumericValue
Modifier and Type | Class | Description |
---|---|---|
protected static class |
DecimalValue.DecimalComparable |
Modifier and Type | Field | Description |
---|---|---|
static java.math.BigDecimal |
BIG_DECIMAL_ONE |
|
static java.math.BigDecimal |
BIG_DECIMAL_ONE_MILLION |
|
static java.math.BigInteger |
BIG_INTEGER_TEN |
|
static int |
DIVIDE_PRECISION |
|
static DecimalValue |
ONE |
|
static DecimalValue |
ZERO |
typeLabel
EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
EMPTY_VALUE_ARRAY
Constructor | Description |
---|---|
DecimalValue(double in) |
Constructor supplying a double
|
DecimalValue(long in) |
Constructor supplying a long integer
|
DecimalValue(java.math.BigDecimal value) |
Constructor supplying a BigDecimal
|
Modifier and Type | Method | Description |
---|---|---|
static boolean |
castableAsDecimal(java.lang.CharSequence in) |
Test whether a string is castable to a decimal value
|
NumericValue |
ceiling() |
Implement the XPath ceiling() function
|
int |
compareTo(long other) |
Compare the value to a long
|
int |
compareTo(java.lang.Object other) |
Compare the value to another numeric value
|
ConversionResult |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context) |
Convert to target data type
|
AtomicValue |
copyAsSubType(AtomicType typeLabel) |
Create a copy of this atomic value, with a different type label
|
static FastStringBuffer |
decimalToString(java.math.BigDecimal value,
FastStringBuffer fsb) |
Convert a decimal value to a string, using the XPath rules for formatting
|
boolean |
effectiveBooleanValue() |
Get the effective boolean value of the value
|
NumericValue |
floor() |
Implement the XPath floor() function
|
java.lang.CharSequence |
getCanonicalLexicalRepresentation() |
Get the canonical lexical representation as defined in XML Schema.
|
java.math.BigDecimal |
getDecimalValue() |
Get the value
|
BuiltInAtomicType |
getPrimitiveType() |
Determine the primitive type of the value.
|
java.lang.Comparable |
getSchemaComparable() |
Get an object that implements XML Schema comparison semantics
|
java.lang.String |
getStringValue() |
Get the value as a String
|
java.lang.CharSequence |
getStringValueCS() |
Get the value of the item as a CharSequence.
|
int |
hashCode() |
Get the hashCode.
|
boolean |
isWholeNumber() |
Determine whether the value is a whole number, that is, whether it compares
equal to some integer
|
static ConversionResult |
makeDecimalValue(java.lang.CharSequence in,
boolean validate) |
Factory method to construct a DecimalValue from a string
|
NumericValue |
negate() |
Negate the value
|
NumericValue |
round() |
Implement the XPath round() function
|
NumericValue |
roundHalfToEven(int scale) |
Implement the XPath round-half-to-even() function
|
double |
signum() |
Determine whether the value is negative, zero, or positive
|
asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence
equals, getDoubleValue, getFloatValue, getXPathComparable, isInteger, longValue, parseNumber, promote, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, iterate, makeQNameValue, reduce, stringToNumber
public static final int DIVIDE_PRECISION
public static final java.math.BigDecimal BIG_DECIMAL_ONE
public static final java.math.BigInteger BIG_INTEGER_TEN
public static final java.math.BigDecimal BIG_DECIMAL_ONE_MILLION
public static final DecimalValue ZERO
public static final DecimalValue ONE
public DecimalValue(java.math.BigDecimal value)
value
- the value of the DecimalValuepublic DecimalValue(double in) throws ValidationException
in
- the value of the DecimalValueValidationException
public DecimalValue(long in)
in
- the value of the DecimalValuepublic static ConversionResult makeDecimalValue(java.lang.CharSequence in, boolean validate)
in
- the value of the DecimalValuevalidate
- true if validation is required; false if the caller knows that the value is validpublic static boolean castableAsDecimal(java.lang.CharSequence in)
in
- the string to be testedpublic AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType
in class AtomicValue
typeLabel
- the type label of the new copy. The caller is responsible for checking that
the value actually conforms to this type.public BuiltInAtomicType getPrimitiveType()
getPrimitiveType
in class AtomicValue
public java.math.BigDecimal getDecimalValue()
getDecimalValue
in class NumericValue
public int hashCode()
hashCode
in class NumericValue
NumericValue.hashCode()
public boolean effectiveBooleanValue()
AtomicValue
effectiveBooleanValue
in class AtomicValue
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
convertPrimitive
in class AtomicValue
requiredType
- the required atomic type. This must either be a primitive type, or a built-in
type derived from the same primitive type as this atomic value.validate
- true if validation is required. If set to false, the caller guarantees that
the value is valid for the target data type, and that further validation
is therefore not required.
Note that a validation failure may be reported even if validation was not requested.context
- The conversion context to be used. This is required at present only when converting to
xs:Name or similar types: it determines the NameChecker to be used.public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
getStringValueCS
in interface ValueRepresentation
getStringValueCS
in class AtomicValue
Item.getStringValue()
public java.lang.CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
in class Value
public java.lang.String getStringValue()
getStringValue
in interface Item
getStringValue
in interface ValueRepresentation
getStringValue
in class AtomicValue
Item.getStringValueCS()
public static FastStringBuffer decimalToString(java.math.BigDecimal value, FastStringBuffer fsb)
value
- the decimal value to be convertedfsb
- the FastStringBuffer to which the value is to be appendedpublic NumericValue negate()
negate
in class NumericValue
public NumericValue floor()
floor
in class NumericValue
public NumericValue ceiling()
ceiling
in class NumericValue
public NumericValue round()
round
in class NumericValue
public NumericValue roundHalfToEven(int scale)
roundHalfToEven
in class NumericValue
scale
- the decimal position for rounding: e.g. 2 rounds to a
multiple of 0.01, while -2 rounds to a multiple of 100public double signum()
signum
in class NumericValue
public boolean isWholeNumber()
isWholeNumber
in class NumericValue
public int compareTo(java.lang.Object other)
compareTo
in class NumericValue
other
- The other numeric valuepublic int compareTo(long other)
compareTo
in class NumericValue
other
- the value to be compared withpublic java.lang.Comparable getSchemaComparable()
getSchemaComparable
in class AtomicValue