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

Class BooleanToken

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

  • Field Details

    • NULL

      public static final BooleanToken NULL
      A null valued BooleanToken

    • TRUE

      public static final BooleanToken TRUE
      A BooleanToken with a value of true

    • FALSE

      public static final BooleanToken FALSE
      A BooleanToken with a value of false

    • ZERO_VALUE

      public static final boolean ZERO_VALUE
      The boolean representing a zero value, false.
      See Also:

    • ZERO

      public static final BooleanToken ZERO
      A zero valued BooleanToken

  • Constructor Details

    • BooleanToken

      public BooleanToken(BooleanValued value)
      Constructs a new token with the boolean value in the given container.

      It is generally preferable to use getToken(BooleanValued) instead.

      Parameters:
      value - a BooleanValued containing the desired value

    • BooleanToken

      public BooleanToken(boolean value)
      Constructs a new token with the given non-null boolean value. If a null valued token is desired, use NULL.

      It is generally preferable to use getToken(boolean) instead.

      Parameters:
      value - the boolean value of the token

  • Method Details

    • getToken

      public static BooleanToken getToken(BooleanValued value)
      Returns a token with the boolean value in the given container. This method does not construct a new object, but returns the appropriate defined constant token instead.
      Parameters:
      value - a BooleanValued containing the desired value
      Returns:
      a token with the specified value

    • getToken

      public static BooleanToken getToken(boolean value)
      Returns a token with the given non-null value boolean value. This method does not construct a new object, but returns the appropriate defined constant token instead.
      Parameters:
      value - the boolean value of the token
      Returns:
      a non-null token with the specified value

    • asObject

      public Boolean 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(BooleanToken that)
      Specified by:
      compareTo in interface Comparable<BooleanToken>

    • 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 BooleanToken parse(String value)
      Converts a string representation of a boolean value into a token.
      Parameters:
      value - a string value to interpret as a boolean; see Boolean.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.

    • 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.

    • asBoolean

      public final boolean asBoolean()
      Description copied from interface: BooleanValued
      Gets the contained boolean value.
      Specified by:
      asBoolean in interface BooleanValued
      Returns:
      the contained value as a boolean. If null valued, as indicated by TokenValued.isNull(), false is returned.

    • 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