Package net.sf.saxon.value
Class Int64Value
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.Int64Value
- 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.
This class supports integer values in the range permitted by a Java "long",
and also supports the built-in subtypes of xs:integer.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Int64Value
IntegerValue representing the maximum value for a longstatic final Int64Value
IntegerValue representing the minimum value for a longstatic final Int64Value
IntegerValue representing the value -1static final Int64Value
IntegerValue representing the value +1static final Int64Value
IntegerValue representing the value zeroFields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
-
Constructor Summary
ConstructorsConstructorDescriptionInt64Value
(long value) Constructor supplying a longInt64Value
(long value, AtomicType typeLabel) Constructor supplying a long, with a specific type annotationInt64Value
(long val, BuiltInAtomicType typeLabel, boolean check) Constructor for a subtype, supplying a long and a type label. -
Method Summary
Modifier and TypeMethodDescriptionabs()
Get the absolute value as defined by the XPath abs() functionGet the value as a BigIntegerint
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 integerlong
Get the valuestatic Int64Value
makeDerived
(long val, AtomicType type) Factory method to create a derived value, with no checking of the value against the derived typestatic Int64Value
makeIntegerValue
(long value) Factory method: allows Int64Value objects to be reused.minus
(IntegerValue other) Subtract another integermod
(IntegerValue other) Take modulo another integernegate()
Negate the valueplus
(IntegerValue other) Add another integerround
(int scale) Implement the XPath round() functionround
(int scale, Round.RoundingRule roundingRule) Implement the XPath round-to-half-even() and round#3 functionsint
signum()
Determine whether the value is negative, zero, or positivestatic Int64Value
signum
(long val) Factory method returning the integer -1, 0, or +1 according as the argument 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, isWholeNumber, 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, reduce, subsequence
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
MINUS_ONE
IntegerValue representing the value -1 -
ZERO
IntegerValue representing the value zero -
PLUS_ONE
IntegerValue representing the value +1 -
MAX_LONG
IntegerValue representing the maximum value for a long -
MIN_LONG
IntegerValue representing the minimum value for a long
-
-
Constructor Details
-
Int64Value
public Int64Value(long value) Constructor supplying a long- Parameters:
value
- the value of the IntegerValue
-
Int64Value
Constructor supplying a long, with a specific type annotation- Parameters:
value
- the value of the IntegerValuetypeLabel
- the type annotation (trusted to be correct)
-
Int64Value
Constructor for a subtype, supplying a long and a type label.- Parameters:
val
- The supplied value, as an integertypeLabel
- the required item type, a subtype of xs:integercheck
- Set to true if the method is required to check that the value is in range; false if the caller can guarantee that the value has already been checked.- Throws:
XPathException
- if the supplied value is out of range for the target type
-
-
Method Details
-
makeIntegerValue
Factory method: allows Int64Value objects to be reused. Note that a value obtained using this method must not be modified to set a type label, because the value is in general shared.- Parameters:
value
- the integer value- Returns:
- an Int64Value with this integer value
-
makeDerived
Factory method to create a derived value, with no checking of the value against the derived type- Parameters:
val
- the integer valuetype
- the subtype of xs:integer- Returns:
- the constructed value
-
signum
Factory method returning the integer -1, 0, or +1 according as the argument is negative, zero, or positive- Parameters:
val
- the value to be tested- Returns:
- the Int64Value representing -1, 0, or +1
-
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
-
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 sets the required type label. Note that this method modifies the value in situ.- 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- Specified by:
longValue
in classNumericValue
- Returns:
- the value of the xs:integer, as a Java long
-
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
-
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
-
getDecimalValue
Get the numeric value converted to a decimal- Specified by:
getDecimalValue
in classIntegerValue
- Returns:
- a decimal representing this numeric value;
-
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 scale (for example scale=2 rounds to 2 decimal places, scale=-2 rounds to a multiple of 100); default value is zero which rounds to an integer- Returns:
- the integer value, unchanged
-
round
Implement the XPath round-to-half-even() and round#3 functions- 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
- indicates how the rounding should be done- 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
-
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
-
asBigInteger
Get the value as a BigInteger- Specified by:
asBigInteger
in classIntegerValue
- Returns:
- the value, as a BigInteger
-