Package net.sf.saxon.value
Class Int64Value
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.IntegerValue
net.sf.saxon.value.Int64Value
- All Implemented Interfaces:
Serializable
,Comparable
,PullEvent
,SequenceIterable
,GroundedValue
,Item
,ValueRepresentation
,ConversionResult
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.
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class net.sf.saxon.value.IntegerValue
MAX_LONG, MIN_LONG, MINUS_ONE, PLUS_ONE, SMALL_INTEGERS, ZERO
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionInt64Value
(long value) Constructor supplying a longInt64Value
(long val, BuiltInAtomicType type, boolean check) Constructor for a subtype, supplying a long and a type label. -
Method Summary
Modifier and TypeMethodDescriptionGet the value as a BigIntegerceiling()
Implement the XPath ceiling() functionboolean
checkRange
(BuiltInAtomicType type) This class allows subtypes of xs:integer to be held, as well as xs:integer values.int
compareTo
(long other) Compare the value to a longint
Compare the value to another numeric valueconvertPrimitive
(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data typeconvertToSubType
(BuiltInAtomicType subtype, boolean validate) Convert the value to a subtype of xs:integercopyAsSubType
(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 an object that implements XML Schema comparison semanticsGet 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()
Implement the XPath round() functionroundHalfToEven
(int scale) Implement the XPath round-to-half-even() functionvoid
setSubType
(AtomicType type) This class allows subtypes of xs:integer to be held, as well as xs:integer values.double
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
checkBigRange, checkRange, getPrimitiveType, isWholeNumber, makeIntegerValue, signum, stringToInteger
Methods inherited from class net.sf.saxon.value.NumericValue
equals, getXPathComparable, isInteger, parseNumber, promote, toString
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence
Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, makeQNameValue, reduce, stringToNumber
-
Constructor Details
-
Int64Value
public Int64Value(long value) Constructor supplying a long- Parameters:
value
- the value of the IntegerValue
-
Int64Value
Constructor for a subtype, supplying a long and a type label.- Parameters:
val
- The supplied value, as an integertype
- 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
-
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
-
convertToSubType
Convert the value to a subtype of xs:integer- Specified by:
convertToSubType
in classIntegerValue
- Parameters:
subtype
- the target subtypevalidate
- true if validation is required; false if the caller already knows that the value is valid- Returns:
- null if the conversion succeeds; a ValidationFailure describing the failure if it fails. Note that the exception is returned, not thrown.
-
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
-
setSubType
This class allows subtypes of xs:integer to be held, as well as xs:integer values. This method sets the required type label. It is the caller's responsibility to check that the value is within range.- Parameters:
type
- the type label to be assigned
-
checkRange
This class allows subtypes of xs:integer to be held, as well as xs:integer values. This method checks that the value is within range, and also sets the type label.- Parameters:
type
- the subtype of integer required- Returns:
- true if successful, false if value is out of range for the subtype
-
getSchemaComparable
Get an object that implements XML Schema comparison semantics- Specified by:
getSchemaComparable
in classAtomicValue
- Returns:
- a Comparable that follows XML Schema comparison rules
-
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- Overrides:
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- Overrides:
effectiveBooleanValue
in classAtomicValue
- Returns:
- false if the integer is zero, otherwise true
-
compareTo
Compare the value to another numeric value- Specified by:
compareTo
in interfaceComparable
- 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
-
convertPrimitive
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type- Specified by:
convertPrimitive
in classAtomicValue
- Parameters:
requiredType
- an integer identifying 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
- XPath dynamic evaluation context- Returns:
- an AtomicValue, a value of the required type
-
getStringValue
Get the value as a String- Specified by:
getStringValue
in interfaceItem
- Specified by:
getStringValue
in interfaceValueRepresentation
- Specified by:
getStringValue
in classAtomicValue
- Returns:
- a String representation of the value
- See Also:
-
getDoubleValue
public double getDoubleValue()Get the numeric value as a double- Overrides:
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- Overrides:
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- Overrides:
getDecimalValue
in classNumericValue
- 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
- Returns:
- the integer value, unchanged
-
roundHalfToEven
Implement the XPath round-to-half-even() function- Specified by:
roundHalfToEven
in classNumericValue
- Parameters:
scale
- number of digits required after the decimal point; the value -2 (for example) means round to a multiple of 100- Returns:
- if the scale is >=0, return this value unchanged. Otherwise round it to a multiple of 10**-scale
-
signum
public double 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
-
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
-