Package net.sf.saxon.value

Class IntegerValue

    • Field Detail

      • MINUS_ONE

        public static final Int64Value MINUS_ONE
        IntegerValue representing the value -1

      • ZERO

        public static final Int64Value ZERO
        IntegerValue representing the value zero

      • 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

      • MAX_LONG

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

      • MIN_LONG

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

    • Constructor Detail

      • IntegerValue

        public IntegerValue()

    • Method Detail

      • makeIntegerValue

        public static IntegerValue makeIntegerValue​(java.math.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

      • 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

      • 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

      • 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

      • checkBigRange

        public static boolean checkBigRange​(java.math.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

      • stringToInteger

        public static ConversionResult stringToInteger​(java.lang.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.

      • 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.
        Specified by:
        getPrimitiveType in class AtomicValue
        Returns:
        the primitive type

      • isWholeNumber

        public boolean isWholeNumber()
        Determine whether the value is a whole number, that is, whether it compares equal to some integer
        Specified by:
        isWholeNumber in class NumericValue
        Returns:
        always true for this implementation

      • plus

        public abstract IntegerValue plus​(IntegerValue other)
        Add another integer
        Parameters:
        other - the other integer
        Returns:
        the result of the addition

      • minus

        public abstract IntegerValue minus​(IntegerValue other)
        Subtract another integer
        Parameters:
        other - the other integer
        Returns:
        the result of the subtraction

      • times

        public abstract IntegerValue times​(IntegerValue other)
        Multiply by another integer
        Parameters:
        other - the other integer
        Returns:
        the result of the multiplication

      • mod

        public abstract IntegerValue mod​(IntegerValue other)
                          throws XPathException
        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

      • asBigInteger

        public abstract java.math.BigInteger asBigInteger()
        Get the value as a BigInteger
        Returns:
        the value, as a BigInteger

      • 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