net.sf.saxon.value

Class IntegerValue

public abstract class IntegerValue extends NumericValue

This class represents the XPath built-in type xs:integer. It is used for all subtypes of xs:integer, other than user-defined subtypes. There are two implementations of IntegerValue: Int64Value, which accommodates values up to 2^63, and BigIntegerValue, which accommodates unlimited-length integers.
Field Summary
static Int64ValueMAX_LONG
IntegerValue representing the maximum value for a long
static Int64ValueMINUS_ONE
IntegerValue representing the value -1
static Int64ValueMIN_LONG
IntegerValue representing the minimum value for a long
static Int64ValuePLUS_ONE
IntegerValue representing the value +1
static Int64Value[]SMALL_INTEGERS
Array of small integer values
static Int64ValueZERO
IntegerValue representing the value zero
Method Summary
abstract BigIntegerasBigInteger()
Get the value as a BigInteger
static booleancheckBigRange(BigInteger big, BuiltInAtomicType type)
Check that a BigInteger is within the required range for a given integer subtype.
static booleancheckRange(long value, BuiltInAtomicType type)
Check that a value is in range for the specified subtype of xs:integer
abstract ValidationFailureconvertToSubType(BuiltInAtomicType type, boolean validate)
This class allows subtypes of xs:integer to be held, as well as xs:integer values.
abstract NumericValuediv(IntegerValue other)
Divide by another integer
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.
abstract IntegerValueidiv(IntegerValue other)
Integer divide by another integer
booleanisIdentical(Value v)
Determine whether two atomic values are identical, as determined by XML Schema rules.
booleanisWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integer
static IntegerValuemakeIntegerValue(BigInteger value)
Factory method: makes either an Int64Value or a BigIntegerValue depending on the value supplied
abstract IntegerValueminus(IntegerValue other)
Subtract another integer
abstract IntegerValuemod(IntegerValue other)
Take modulo another integer
abstract IntegerValueplus(IntegerValue other)
Add another integer
protected static intsignum(int i)
Get the signum of an int
static ConversionResultstringToInteger(CharSequence s)
Static factory method to convert strings to integers.
abstract IntegerValuetimes(IntegerValue other)
Multiply by another integer
abstract ValidationFailurevalidateAgainstSubType(BuiltInAtomicType type)
This class allows subtypes of xs:integer to be held, as well as xs:integer values.

Field Detail

MAX_LONG

public static final Int64Value MAX_LONG
IntegerValue representing the maximum value for a long

MINUS_ONE

public static final Int64Value MINUS_ONE
IntegerValue representing the value -1

MIN_LONG

public static final Int64Value MIN_LONG
IntegerValue representing the minimum value for a long

PLUS_ONE

public static final Int64Value PLUS_ONE
IntegerValue representing the value +1

SMALL_INTEGERS

public static final Int64Value[] SMALL_INTEGERS
Array of small integer values

ZERO

public static final Int64Value ZERO
IntegerValue representing the value zero

Method Detail

asBigInteger

public abstract BigInteger asBigInteger()
Get the value as a BigInteger

Returns: the value, as a BigInteger

checkBigRange

public static boolean checkBigRange(BigInteger big, BuiltInAtomicType type)
Check that a BigInteger is within the required range for a given integer subtype. This method is expensive, so it should not be used unless the BigInteger is outside the range of a long.

Parameters: big the supplied BigInteger type the derived type (a built-in restriction of xs:integer) to check the value against

Returns: true if the value is within the range for the derived type

checkRange

public static boolean checkRange(long value, BuiltInAtomicType type)
Check that a value is in range for the specified subtype of xs:integer

Parameters: value the value to be checked type the required item type, a subtype of xs:integer

Returns: true if successful, false if value is out of range for the subtype

convertToSubType

public abstract ValidationFailure convertToSubType(BuiltInAtomicType type, boolean validate)
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.

Parameters: type the subtype of integer required validate true if validation is required, false if the caller warrants that the value is valid for the subtype

Returns: null if the operation succeeds, or a ValidationException if the value is out of range

div

public abstract NumericValue div(IntegerValue other)
Divide by another integer

Parameters: other the other integer

Returns: the result of the division

Throws: XPathException if the other integer is zero

getPrimitiveType

public BuiltInAtomicType getPrimitiveType()
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.

idiv

public abstract IntegerValue idiv(IntegerValue other)
Integer divide by another integer

Parameters: other the other integer

Returns: the result of the integer division

Throws: XPathException if the other integer is zero

isIdentical

public boolean isIdentical(Value v)
Determine whether two atomic values are identical, as determined by XML Schema rules. This is a stronger test than equality (even schema-equality); for example two dateTime values are not identical unless they are in the same timezone.

Note that even this check ignores the type annotation of the value. The integer 3 and the short 3 are considered identical, even though they are not fully interchangeable. "Identical" means the same point in the value space, regardless of type annotation.

NaN is identical to itself.

Parameters: v the other value to be compared with this one

Returns: true if the two values are identical, false otherwise.

isWholeNumber

public boolean isWholeNumber()
Determine whether the value is a whole number, that is, whether it compares equal to some integer

Returns: always true for this implementation

makeIntegerValue

public static IntegerValue makeIntegerValue(BigInteger value)
Factory method: makes either an Int64Value or a BigIntegerValue depending on the value supplied

Parameters: value the supplied integer value

Returns: the value as a BigIntegerValue or Int64Value as appropriate

minus

public abstract IntegerValue minus(IntegerValue other)
Subtract another integer

Parameters: other the other integer

Returns: the result of the subtraction

mod

public abstract IntegerValue mod(IntegerValue other)
Take modulo another integer

Parameters: other the other integer

Returns: the result of the modulo operation (the remainder)

Throws: XPathException if the other integer is zero

plus

public abstract IntegerValue plus(IntegerValue other)
Add another integer

Parameters: other the other integer

Returns: the result of the addition

signum

protected static int signum(int i)
Get the signum of an int

Parameters: i the int

Returns: -1 if the integer is negative, 0 if it is zero, +1 if it is positive

stringToInteger

public static ConversionResult stringToInteger(CharSequence s)
Static factory method to convert strings to integers.

Parameters: s CharSequence representing the string to be converted

Returns: either an Int64Value or a BigIntegerValue representing the value of the String, or a ValidationFailure encapsulating an Exception if the value cannot be converted.

times

public abstract IntegerValue times(IntegerValue other)
Multiply by another integer

Parameters: other the other integer

Returns: the result of the multiplication

validateAgainstSubType

public abstract ValidationFailure validateAgainstSubType(BuiltInAtomicType type)
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.

Parameters: type the subtype of integer required

Returns: null if the operation succeeds, or a ValidationException if the value is out of range