public final class DecimalValue extends NumericValue
Modifier and Type | Field and Description |
---|---|
static BigDecimal |
ONE |
static BigDecimal |
ONE_MILLION |
static BigInteger |
TEN |
EMPTY_CLASS_ARRAY
EMPTY_VALUE_ARRAY
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
Constructor and Description |
---|
DecimalValue(BigDecimal value)
Constructor supplying a BigDecimal
|
DecimalValue(double in)
Constructor supplying a double
|
DecimalValue(long in)
Constructor supplying a long integer
|
Modifier and Type | Method and Description |
---|---|
NumericValue |
arithmetic(int operator,
NumericValue other,
XPathContext context)
Evaluate a binary arithmetic operator.
|
NumericValue |
ceiling()
Implement the XPath ceiling() function
|
int |
compareTo(Object other)
Compare the value to another numeric value
|
AtomicValue |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context)
Convert to target data type
|
Object |
convertToJava(Class target,
XPathContext context)
Convert to Java object (for passing to external functions)
|
static String |
decimalToString(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
|
String |
getStringValue()
Get the value as a String
|
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(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 |
roundToHalfEven(int scale)
Implement the XPath round-to-half-even() function
|
boolean |
schemaEquals(Value obj)
Compare two values for equality.
|
double |
signum()
Determine whether the value is negative, zero, or positive
|
equals, getDoubleValue, isInteger, isNaN, longValue, parseNumber, promote, toString
checkPermittedContents, convert, convert, display, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getLength, getPrimitiveValue, getStringValueCS, getTypedValue, hasBuiltInType, iterate, process
asItem, asIterator, asValue, collapseWhitespace, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, normalizeWhitespace, optimize, promote, reduce, simplify, stringToNumber, trimWhitespace, typeCheck
public static final BigDecimal ONE
public static final BigInteger TEN
public static final BigDecimal ONE_MILLION
public DecimalValue(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(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 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 String getStringValue()
getStringValue
in interface Item
getStringValue
in interface ValueRepresentation
getStringValue
in class AtomicValue
Item.getStringValueCS()
public static String decimalToString(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 roundToHalfEven(int scale)
roundToHalfEven
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(Object other)
compareTo
in interface Comparable
compareTo
in class NumericValue
other
- The other numeric valuepublic boolean schemaEquals(Value obj)
schemaEquals
in class AtomicValue
public Object convertToJava(Class target, XPathContext context) throws XPathException
convertToJava
in class Value
XPathException