Package net.sf.saxon.value
Class BigIntegerValue
java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.DecimalValue
net.sf.saxon.value.IntegerValue
net.sf.saxon.value.BigIntegerValue
- All Implemented Interfaces:
Comparable<XPathComparable>
,Iterable<AtomicValue>
,AtomicMatchKey
,XPathComparable
,AtomicSequence
,GroundedValue
,IdentityComparable
,Item
,Sequence
,ConversionResult
,ContextFreeAtomicValue
An integer value: note this is a subtype of decimal in XML Schema, not a primitive type.
The abstract class IntegerValue is used to represent any xs:integer value; this implementation
is used for values that do not fit comfortably in a Java long; including the built-in subtype xs:unsignedLong
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BigInteger
static final BigInteger
static final BigInteger
static final BigIntegerValue
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
-
Constructor Summary
ConstructorsConstructorDescriptionBigIntegerValue
(long value) Construct an xs:integer value from a Java long.BigIntegerValue
(BigInteger value) Construct an xs:integer value from a Java BigIntegerBigIntegerValue
(BigInteger value, AtomicType typeLabel) Construct an xs:integer value from a Java BigInteger, supplying a type label. -
Method Summary
Modifier and TypeMethodDescriptionabs()
Get the absolute value as defined by the XPath abs() functionGet the value as a BigIntegerConvert the value to a BigDecimalint
Test whether a number is a possible subscript into a sequence, that is, a whole number greater than zero and less than 2^31ceiling()
Implement the XPath ceiling() functionint
compareTo
(long other) Compare the value to a longint
compareTo
(XPathComparable other) Compare the value to another numeric valuecopyAsSubType
(AtomicType typeLabel) Create a copy of this atomic value, with a different type labeldiv
(IntegerValue other) Divide by another integerboolean
Return the effective boolean value of this integerfloor()
Implement the XPath floor() functionGet the numeric value converted to a decimaldouble
Get the numeric value as a doublefloat
Get the numeric value converted to a floatGet the value as a Stringint
hashCode()
Get the hashCode.idiv
(IntegerValue other) Integer divide by another integerboolean
Determine whether the value is a whole number, that is, whether it compares equal to some integerboolean
Test whether the value is within the range that can be held in a 64-bit signed integerlong
Get the value as a longminus
(IntegerValue other) Subtract another integermod
(IntegerValue other) Take modulo another integernegate()
Negate the valueplus
(IntegerValue other) Add another integerreduce()
Reduce a value to its simplest form.round
(int scale) Implement the XPath round() functionround
(int scale, Round.RoundingRule roundingRule) Implement the XPath round-to-half-even() or round#3 functionint
signum()
Determine whether the value is negative, zero, or positivetimes
(IntegerValue other) Multiply by another integerThis class allows subtypes of xs:integer to be held, as well as xs:integer values.Methods inherited from class net.sf.saxon.value.IntegerValue
castableAsInteger, checkBigRange, checkRange, div, fromDouble, getMaxInclusive, getMinInclusive, getPrimitiveType, idiv, isIdentical, makeIntegerValue, mod, signum, stringToInteger
Methods inherited from class net.sf.saxon.value.NumericValue
equals, getXPathComparable, getXPathComparable, getXPathMatchKey, isInteger, isNegativeZero, parseNumber, show
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, getCanonicalLexicalRepresentation, getCardinality, getComponent, getGenre, getItemType, getLength, getUnicodeStringValue, getUType, head, identityHashCode, isIdentical, isNaN, isUntypedAtomic, itemAt, iterate, iterator, toShortString, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
asAtomic
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getStringValue, isStreamed, subsequence
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
MAX_LONG
-
MIN_LONG
-
MAX_UNSIGNED_LONG
-
ZERO
-
-
Constructor Details
-
BigIntegerValue
Construct an xs:integer value from a Java BigInteger- Parameters:
value
- the supplied BigInteger
-
BigIntegerValue
Construct an xs:integer value from a Java BigInteger, supplying a type label. It is the caller's responsibility to ensure that the supplied value conforms with the rules for the specified type.- Parameters:
value
- the value of the integertypeLabel
- the type, which must represent a type derived from xs:integer
-
BigIntegerValue
public BigIntegerValue(long value) Construct an xs:integer value from a Java long. Note: normally, if the value fits in a long, then an Int64Value should be used. This constructor is largely for internal use, when operations are required that require two integers to use the same implementation class to be used.- Parameters:
value
- the supplied Java long
-
-
Method Details
-
copyAsSubType
Create a copy of this atomic value, with a different type label- Specified by:
copyAsSubType
in classAtomicValue
- Parameters:
typeLabel
- the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.- Returns:
- the copied value
-
validateAgainstSubType
This class allows subtypes of xs:integer to be held, as well as xs:integer values. This method checks that the value is valid against the rules for a given subtype.- Specified by:
validateAgainstSubType
in classIntegerValue
- Parameters:
type
- the subtype of integer required- Returns:
- null if the operation succeeds, or a ValidationException if the value is out of range
-
hashCode
public int hashCode()Get the hashCode. This must conform to the rules for other NumericValue hashcodes- Specified by:
hashCode
in classNumericValue
- Returns:
- the hash code of the numeric value
- See Also:
-
longValue
public long longValue()Get the value as a long- Specified by:
longValue
in classNumericValue
- Returns:
- the value of the xs:integer, as a Java long
-
asBigInteger
Get the value as a BigInteger- Specified by:
asBigInteger
in classIntegerValue
- Returns:
- the value of the xs:integer as a Java BigInteger
-
isWithinLongRange
public boolean isWithinLongRange()Test whether the value is within the range that can be held in a 64-bit signed integer- Returns:
- true if the value is within range for a long
-
asDecimal
Convert the value to a BigDecimal- Returns:
- the resulting BigDecimal
-
effectiveBooleanValue
public boolean effectiveBooleanValue()Return the effective boolean value of this integer- Specified by:
effectiveBooleanValue
in interfaceGroundedValue
- Specified by:
effectiveBooleanValue
in classNumericValue
- Returns:
- false if the integer is zero, otherwise true
-
compareTo
Compare the value to another numeric value- Specified by:
compareTo
in interfaceComparable<XPathComparable>
- Overrides:
compareTo
in classNumericValue
- Parameters:
other
- the numeric value to be compared to this value- Returns:
- -1 if this value is less than the other, 0 if they are equal, +1 if this value is greater
-
compareTo
public int compareTo(long other) Compare the value to a long- Specified by:
compareTo
in classNumericValue
- Parameters:
other
- the value to be compared with- Returns:
- -1 if this is less, 0 if this is equal, +1 if this is greater or if this is NaN
-
getPrimitiveStringValue
Get the value as a String- Specified by:
getPrimitiveStringValue
in classAtomicValue
- Returns:
- a String representation of the value
-
getDoubleValue
public double getDoubleValue()Get the numeric value as a double- Specified by:
getDoubleValue
in classNumericValue
- Returns:
- A double representing this numeric value; NaN if it cannot be converted
-
getDecimalValue
Get the numeric value converted to a decimal- Specified by:
getDecimalValue
in classIntegerValue
- Returns:
- a decimal representing this numeric value;
-
getFloatValue
public float getFloatValue()Get the numeric value converted to a float- Specified by:
getFloatValue
in classNumericValue
- Returns:
- a float representing this numeric value; NaN if it cannot be converted
-
negate
Negate the value- Specified by:
negate
in classNumericValue
- Returns:
- the result of inverting the sign of the value
-
floor
Implement the XPath floor() function- Specified by:
floor
in classNumericValue
- Returns:
- the integer value, unchanged
-
ceiling
Implement the XPath ceiling() function- Specified by:
ceiling
in classNumericValue
- Returns:
- the integer value, unchanged
-
round
Implement the XPath round() function- Specified by:
round
in classNumericValue
- Parameters:
scale
- the number of decimal places required in the result (supply 0 for rounding to an integer)- Returns:
- the integer value, unchanged
-
round
Implement the XPath round-to-half-even() or round#3 function- Specified by:
round
in classNumericValue
- Parameters:
scale
- number of digits required after the decimal point; the value -2 (for example) means round to a multiple of 100roundingRule
- how rounding is performed- Returns:
- if the scale is >=0, return this value unchanged. Otherwise round it to a multiple of 10**-scale
-
signum
public int signum()Determine whether the value is negative, zero, or positive- Specified by:
signum
in classNumericValue
- Returns:
- -1 if negative, 0 if zero, +1 if positive, NaN if NaN
-
abs
Get the absolute value as defined by the XPath abs() function- Specified by:
abs
in classNumericValue
- Returns:
- the absolute value
-
isWholeNumber
public boolean isWholeNumber()Determine whether the value is a whole number, that is, whether it compares equal to some integer- Overrides:
isWholeNumber
in classIntegerValue
- Returns:
- always true for this implementation
-
asSubscript
public int asSubscript()Test whether a number is a possible subscript into a sequence, that is, a whole number greater than zero and less than 2^31- Specified by:
asSubscript
in classNumericValue
- Returns:
- the number as an int if it is a possible subscript, or -1 otherwise
-
plus
Add another integer- Specified by:
plus
in classIntegerValue
- Parameters:
other
- the other integer- Returns:
- the result of the addition
-
minus
Subtract another integer- Specified by:
minus
in classIntegerValue
- Parameters:
other
- the other integer- Returns:
- the result of the subtraction
-
times
Multiply by another integer- Specified by:
times
in classIntegerValue
- Parameters:
other
- the other integer- Returns:
- the result of the multiplication
-
div
Divide by another integer- Specified by:
div
in classIntegerValue
- Parameters:
other
- the other integer- Returns:
- the result of the division
- Throws:
XPathException
- if the other integer is zero
-
mod
Take modulo another integer- Specified by:
mod
in classIntegerValue
- Parameters:
other
- the other integer- Returns:
- the result of the modulo operation (the remainder)
- Throws:
XPathException
- if the other integer is zero
-
idiv
Integer divide by another integer- Specified by:
idiv
in classIntegerValue
- Parameters:
other
- the other integer- Returns:
- the result of the integer division
- Throws:
XPathException
- if the other integer is zero
-
reduce
Reduce a value to its simplest form.- Returns:
- the simplified sequence
-