Class IntRegister

    • Constructor Detail

      • IntRegister

        public IntRegister()
        Creates a new null-valued register.
    • Method Detail

      • setNull

        public void setNull()
        Description copied from interface: TokenSettable
        Sets the contained value to be null valued.
        Specified by:
        setNull in interface TokenSettable
      • setZero

        public void setZero()
        Description copied from interface: TokenSettable
        Sets the contained value to be zero valued.
        Specified by:
        setZero in interface TokenSettable
      • set

        public void set​(int value)
        Description copied from interface: IntSettable
        Sets the container to the given integer value.
        Specified by:
        set in interface IntSettable
        Parameters:
        value - integer value to which to set the container
      • set

        public void set​(TokenValued value)
        Description copied from interface: TokenSettable
        Sets the contained value to the given token value. The given value must have a type compatible with this object.
        Specified by:
        set in interface TokenSettable
        Parameters:
        value - the value to which to set the container
      • 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.
      • 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