Class BigIntegerValue

java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.BigIntegerValue
All Implemented Interfaces:
Serializable, Comparable, Expression, Item, ValueRepresentation
public final class BigIntegerValue extends NumericValue
An integer value: note this is a subtype of decimal in XML Schema, not a primitive type. The class IntegerValue is used to represent xs:integer values that fit comfortably in a Java long; this class is used to represent xs:integer values outside this range, including the built-in subtype xs:unsignedLong
See Also:

  • Field Details

  • Constructor Details

    • BigIntegerValue

      public BigIntegerValue(BigInteger value)

    • BigIntegerValue

      public BigIntegerValue(long value)

  • Method Details

    • convertToSubType

      public ValidationException convertToSubType(AtomicType 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.
      Parameters:
      type - the subtype of integer required
      Returns:
      null if the operation succeeds, or a ValidationException if the value is out of range

    • makeValue

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

    • 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 as a long
      Overrides:
      longValue in class NumericValue
      Returns:
      the value of the xs:integer, as a Java long

    • getBigInteger

      public BigInteger getBigInteger()
      Get the value as a BigInteger
      Returns:
      teh value of the xs:integer as a Java BigInteger

    • isWithinLongRange

      public boolean isWithinLongRange()

    • asDecimal

      public BigDecimal asDecimal()

    • 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; or an ErrorValue

    • 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