Module datarush.library
Package com.pervasive.datarush.tokens.scalar

Class IntToken

java.lang.Object
com.pervasive.datarush.tokens.scalar.IntToken
All Implemented Interfaces:
DataToken, DoubleValued, FloatValued, IntValued, LongValued, NumericValued, ScalarToken, ScalarValued, TokenValued, ScalarTyped, TokenTyped, Serializable, Comparable<IntToken>
public final class IntToken extends Object implements ScalarToken, Comparable<IntToken>
An immutable IntValued object.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final IntToken
    NULL
    A null valued IntToken
    static final IntToken
    ZERO
    A zero valued IntToken
    static final int
    ZERO_VALUE
    The int zero value, 0.

    Fields inherited from interface com.pervasive.datarush.tokens.scalar.NumericValued

    MAX_INFINITY, MIN_INFINITY

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntToken(int value)
    Constructs a new token with the given non-null integer value.
    IntToken(IntValued value)
    Constructs a new token with the integer value in the given container.

  • Method Summary

    Modifier and Type
    Method
    Description
    final BigDecimal
    asBigDecimal()
    Gets the contained numeric value.
    final double
    asDouble()
    Gets the contained double value.
    final float
    asFloat()
    Gets the contained float value.
    final int
    asInt()
    Gets the contained integer value.
    final long
    asLong()
    Gets the contained long value.
    Integer
    asObject()
    Gets the value of the token as an object.
    int
    compareTo(IntToken that)
     
    boolean
    equals(Object obj)
    Indicates whether another object is equal to this token.
    final ScalarTokenType
    getType()
    Gets the data type of the token.
    int
    hashCode()
    Returns a hash code for the token.
    final boolean
    isNull()
    Indicates whether the token is null valued.
    final boolean
    isZero()
    Indicates whether the value is the zero value for the type.
    static IntToken
    parse(String value)
    Converts a string representation of an int value into a token.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.pervasive.datarush.tokens.DataToken

    toString

    Methods inherited from interface com.pervasive.datarush.tokens.scalar.ScalarValued

    getType, isZero

    Methods inherited from interface com.pervasive.datarush.tokens.TokenValued

    isNull

  • Field Details

    • NULL

      public static final IntToken NULL
      A null valued IntToken

    • ZERO_VALUE

      public static final int ZERO_VALUE
      The int zero value, 0.
      See Also:

    • ZERO

      public static final IntToken ZERO
      A zero valued IntToken

  • Constructor Details

    • IntToken

      public IntToken(IntValued value)
      Constructs a new token with the integer value in the given container.
      Parameters:
      value - a IntValued containing the desired value

    • IntToken

      public IntToken(int value)
      Constructs a new token with the given non-null integer value. If a null valued token is desired, use NULL.
      Parameters:
      value - the integer value of the token

  • Method Details

    • asObject

      public Integer asObject()
      Gets the value of the token as an object.
      Returns:
      an object representing the token value, null if the token is null valued.

    • compareTo

      public int compareTo(IntToken that)
      Specified by:
      compareTo in interface Comparable<IntToken>

    • equals

      public boolean equals(Object obj)
      Description copied from interface: DataToken
      Indicates whether another object is equal to this token. Two null valued tokens are considered equal. This differs from the behavior of TokenComparator.equal(TokenValued,TokenValued) but makes it possible to store DataTokens in Maps.
      Specified by:
      equals in interface DataToken
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare
      Returns:
      true if the other object is a token of the same type and contains the same value, false otherwise.

    • hashCode

      public int hashCode()
      Description copied from interface: DataToken
      Returns a hash code for the token. This value is guaranteed to be consistent with that returned by TokenConverter.asHashCode(TokenValued).
      Specified by:
      hashCode in interface DataToken
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for the token

    • parse

      public static IntToken parse(String value)
      Converts a string representation of an int value into a token.
      Parameters:
      value - a string value to interpret as a int; see Integer.valueOf(String)
      Returns:
      a token with the specified value

    • getType

      public final ScalarTokenType getType()
      Description copied from interface: TokenValued
      Gets the data type of the token. This type will dictate the valid values that can be contained.
      Specified by:
      getType in interface ScalarTyped
      Specified by:
      getType in interface ScalarValued
      Specified by:
      getType in interface TokenTyped
      Specified by:
      getType in interface TokenValued
      Returns:
      the token type.

    • asBigDecimal

      public final BigDecimal asBigDecimal()
      Description copied from interface: NumericValued
      Gets the contained numeric value.
      Specified by:
      asBigDecimal in interface NumericValued
      Returns:
      the contained value as a java.math.BigDecimal. If null valued, as indicated by TokenValued.isNull(), null is returned.

    • asDouble

      public final double asDouble()
      Description copied from interface: DoubleValued
      Gets the contained double value.
      Specified by:
      asDouble in interface DoubleValued
      Returns:
      the contained value as a double. If null valued, as indicated by TokenValued.isNull(), Double.NaN is returned.

    • asFloat

      public final float asFloat()
      Description copied from interface: FloatValued
      Gets the contained float value.
      Specified by:
      asFloat in interface FloatValued
      Returns:
      the contained value as a float. If null valued, as indicated by TokenValued.isNull(), Float.NaN is returned.

    • asLong

      public final long asLong()
      Description copied from interface: LongValued
      Gets the contained long value.
      Specified by:
      asLong in interface LongValued
      Returns:
      the contained value as a long. If null valued, as indicated by TokenValued.isNull(), 0 is returned.

    • asInt

      public final int asInt()
      Description copied from interface: IntValued
      Gets the contained integer value.
      Specified by:
      asInt in interface IntValued
      Returns:
      the contained value as an int. If null valued, as indicated by TokenValued.isNull(), 0 is returned.

    • isZero

      public final boolean isZero()
      Description copied from interface: ScalarValued
      Indicates whether the value is the zero value for the type. Zero values are not stored in sparse representation formats.
      Specified by:
      isZero in interface ScalarValued
      Returns:
      true if the value is the zero value, false otherwise.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isNull

      public final boolean isNull()
      Description copied from interface: TokenValued
      Indicates whether the token is null valued. Tokens support null values analogous to SQL. Before accessing the value of the container, it is usually best to ensure it is not null valued using this method.
      Specified by:
      isNull in interface TokenValued
      Returns:
      true if the token is null valued, false otherwise