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

Class CharToken

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CharToken
    NULL
    A null valued CharToken
    static final CharToken
    ZERO
    A zero valued CharToken
    static final char
    ZERO_VALUE
    The character representing a zero value, '\0'.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CharToken(char value)
    Constructs a new token with the given non-null character value.
    CharToken(CharValued value)
    Constructs a new token with the character value in the given container.

  • Method Summary

    Modifier and Type
    Method
    Description
    final char
    asChar()
    Gets the contained character value.
    Character
    asObject()
    Gets the value of the token as an object.
    int
    compareTo(CharToken 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 CharToken
    parse(String value)
    Converts a string representation of a char 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 CharToken NULL
      A null valued CharToken

    • ZERO_VALUE

      public static final char ZERO_VALUE
      The character representing a zero value, '\0'.
      See Also:

    • ZERO

      public static final CharToken ZERO
      A zero valued CharToken

  • Constructor Details

    • CharToken

      public CharToken(CharValued value)
      Constructs a new token with the character value in the given container.
      Parameters:
      value - a CharValued containing the desired value

    • CharToken

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

  • Method Details

    • compareTo

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

    • asObject

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

    • 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 CharToken parse(String value)
      Converts a string representation of a char value into a token.
      Parameters:
      value - a string value to interpret as a character; this must be exactly 1 character in length
      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.

    • asChar

      public final char asChar()
      Description copied from interface: CharValued
      Gets the contained character value.
      Specified by:
      asChar in interface CharValued
      Returns:
      the contained value as a char. If null valued, as indicated by TokenValued.isNull(), Character.MAX_VALUE 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