java.io.Serializable
, java.lang.Comparable
, Expression
, Item
, ValueRepresentation
public final class DecimalValue extends NumericValue
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 DecimalValue |
ONE |
|
static DecimalValue |
ZERO |
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
EMPTY_CLASS_ARRAY
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 |
---|---|---|
NumericValue |
arithmetic(int operator,
NumericValue other,
XPathContext context) |
Evaluate a binary arithmetic operator.
|
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
|
AtomicValue |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context) |
Convert to target data type
|
java.lang.Object |
convertToJava(java.lang.Class target,
XPathContext context) |
Convert to Java object (for passing to external functions)
|
static java.lang.CharSequence |
decimalToString(java.math.BigDecimal value) |
|
boolean |
effectiveBooleanValue(XPathContext context) |
Get the effective boolean value of the value
|
NumericValue |
floor() |
Implement the XPath floor() function
|
ItemType |
getItemType(TypeHierarchy th) |
Determine the data type of the expression
|
java.lang.String |
getStringValue() |
Get the value as a String
|
java.lang.CharSequence |
getStringValueCS() |
Get the value of the item as a CharSequence.
|
java.math.BigDecimal |
getValue() |
Get the value
|
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 AtomicValue |
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
|
checkPermittedContents, convert, convert, display, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process
equals, getDoubleValue, isInteger, isNaN, longValue, parseNumber, promote, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck
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 AtomicValue 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)
public java.math.BigDecimal getValue()
public int hashCode()
hashCode
in class NumericValue
NumericValue.hashCode()
public boolean effectiveBooleanValue(XPathContext context)
AtomicValue
effectiveBooleanValue
in interface Expression
effectiveBooleanValue
in class AtomicValue
context
- the evaluation context (not used in this implementation)public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
convertPrimitive
in class AtomicValue
requiredType
- type code of the required atomic typevalidate
- 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
a date or time: it provides the implicit timezone.public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
getStringValueCS
in interface ValueRepresentation
getStringValueCS
in class AtomicValue
Item.getStringValue()
public java.lang.String getStringValue()
getStringValue
in interface Item
getStringValue
in interface ValueRepresentation
getStringValue
in class AtomicValue
Item.getStringValueCS()
public static java.lang.CharSequence decimalToString(java.math.BigDecimal value)
public ItemType getItemType(TypeHierarchy th)
getItemType
in interface Expression
getItemType
in class Value
th
- public 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 NumericValue arithmetic(int operator, NumericValue other, XPathContext context) throws XPathException
arithmetic
in class NumericValue
operator
- the binary arithmetic operation to be performed. Uses
the constants defined in the Tokenizer classother
- the other operandXPathException
- if an arithmetic error occursTokenizer
public int compareTo(java.lang.Object other)
compareTo
in interface java.lang.Comparable
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.Object convertToJava(java.lang.Class target, XPathContext context) throws XPathException
convertToJava
in class Value
XPathException