Class IntegerValue

All Implemented Interfaces:
Serializable, Comparable, Expression, Item, ValueRepresentation

public final class IntegerValue extends NumericValue
An integer value: note this is a subtype of decimal in XML Schema, not a primitive type. This class also supports the built-in subtypes of xs:integer. Actually supports a value in the range permitted by a Java "long"
See Also:
  • Field Details

    • MINUS_ONE

      public static final IntegerValue MINUS_ONE
      IntegerValue representing the value -1
    • ZERO

      public static final IntegerValue ZERO
      IntegerValue representing the value zero
    • PLUS_ONE

      public static final IntegerValue PLUS_ONE
      IntegerValue representing the value +1
    • MAX_LONG

      public static final IntegerValue MAX_LONG
      IntegerValue representing the maximum value for this class
    • MIN_LONG

      public static final IntegerValue MIN_LONG
      IntegerValue representing the minimum value for this class
  • Constructor Details

    • IntegerValue

      public IntegerValue(long value)
      Constructor supplying a long
      Parameters:
      value - the value of the IntegerValue
    • IntegerValue

      public IntegerValue(long val, AtomicType type) throws DynamicError
      Constructor for a subtype, supplying an integer
      Parameters:
      val - The supplied value, as an integer
      type - the required item type, a subtype of xs:integer
      Throws:
      DynamicError - if the supplied value is out of range for the target type
  • Method Details

    • convertToSubtype

      public ValidationException convertToSubtype(AtomicType subtype, boolean validate)
      Convert the value to a subtype of xs:integer
      Parameters:
      subtype - the target subtype
      validate - true if validation is required; false if the caller already knows that the value is valid
      Returns:
      null if the conversion succeeds; a ValidationException describing the failure if it fails. Note that the exception is returned, not thrown.
    • setSubType

      public void setSubType(AtomicType type)
      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.
    • checkRange

      public boolean checkRange(AtomicType type)
      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
    • stringToInteger

      public static AtomicValue stringToInteger(CharSequence s)
      Static factory method to convert strings to integers.
      Parameters:
      s - CharSequence representing the string to be converted
      Returns:
      either an IntegerValue or a BigIntegerValue representing the value of the String, or an ErrorValue encapsulating an Exception if the value cannot be converted.
    • checkRange

      static boolean checkRange(long value, AtomicType 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

      static boolean checkBigRange(BigInteger big, AtomicType 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.
    • hashCode

      public int hashCode()
      Get the hashCode. This must conform to the rules for other NumericValue hashcodes
      Specified by:
      hashCode in class NumericValue
      Returns:
      the hash code of the numeric value
      See Also:
    • longValue

      public long longValue()
      Get the value
      Overrides:
      longValue in class NumericValue
      Returns:
      the value of the xs:integer, as a Java long
    • effectiveBooleanValue

      public boolean effectiveBooleanValue(XPathContext context)
      Return the effective boolean value of this integer
      Specified by:
      effectiveBooleanValue in interface Expression
      Overrides:
      effectiveBooleanValue in class AtomicValue
      Parameters:
      context - The dynamic evaluation context; ignored in this implementation of the method
      Returns:
      false if the integer is zero, otherwise true
    • compareTo

      public int compareTo(Object other)
      Compare the value to another numeric value
      Specified by:
      compareTo in interface Comparable
      Overrides:
      compareTo in class NumericValue
      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 class NumericValue
      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 AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
      Convert to target data type
      Specified by:
      convertPrimitive in class AtomicValue
      Parameters:
      requiredType - an integer identifying the required atomic type
      validate - 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 -
      Returns:
      an AtomicValue, a value of the required type
    • getStringValue

      public String getStringValue()
      Get the value as a String
      Specified by:
      getStringValue in interface Item
      Specified by:
      getStringValue in interface ValueRepresentation
      Specified by:
      getStringValue in class AtomicValue
      Returns:
      a String representation of the value
      See Also:
    • negate

      public NumericValue negate()
      Negate the value
      Specified by:
      negate in class NumericValue
      Returns:
      the result of inverting the sign of the value
    • floor

      public NumericValue floor()
      Implement the XPath floor() function
      Specified by:
      floor in class NumericValue
      Returns:
      the integer value, unchanged
    • ceiling

      public NumericValue ceiling()
      Implement the XPath ceiling() function
      Specified by:
      ceiling in class NumericValue
      Returns:
      the integer value, unchanged
    • round

      public NumericValue round()
      Implement the XPath round() function
      Specified by:
      round in class NumericValue
      Returns:
      the integer value, unchanged
    • roundHalfToEven

      public NumericValue roundHalfToEven(int scale)
      Implement the XPath round-to-half-even() function
      Specified by:
      roundHalfToEven in class NumericValue
      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 class NumericValue
      Returns:
      -1 if negative, 0 if zero, +1 if positive, NaN if NaN
    • 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
    • arithmetic

      public NumericValue arithmetic(int operator, NumericValue other, XPathContext context) throws XPathException
      Evaluate a binary arithmetic operator.
      Specified by:
      arithmetic in class NumericValue
      Parameters:
      operator - the operator to be applied, identified by a constant in the Tokenizer class
      other - the other operand of the arithmetic expression
      Returns:
      the result of performing the arithmetic operation
      Throws:
      XPathException - if an arithmetic failure occurs, e.g. divide by zero
      See Also:
    • getItemType

      public ItemType getItemType(TypeHierarchy th)
      Determine the data type of the expression
      Specified by:
      getItemType in interface Expression
      Overrides:
      getItemType in class Value
      Parameters:
      th -
      Returns:
      the actual data type
    • convertToJava

      public Object convertToJava(Class target, XPathContext context) throws XPathException
      Convert to Java object (for passing to external functions)
      Overrides:
      convertToJava in class Value
      Parameters:
      target - The Java class to which conversion is required
      Returns:
      the Java object that results from the conversion; always an instance of the target class
      Throws:
      XPathException - if conversion is not possible, or fails