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

Class Ip4AddressToken

    • Field Detail

      • NULL

        public static final Ip4AddressToken NULL
        A null valued Ip4AddressToken

      • ZERO_VALUE

        public static final byte[] ZERO_VALUE
        The byte array representing the 0.0.0.0 ip address, the empty byte[4].

      • ZERO

        public static final Ip4AddressToken ZERO
        A zero valued Ip4AddressToken

    • Constructor Detail

      • Ip4AddressToken

        public Ip4AddressToken​(Ip4AddressValued value)
        Constructs a new token with the ip4 address value in the given container.
        Parameters:
        value - a Ip4AddressValued containing the desired value

      • Ip4AddressToken

        public Ip4AddressToken​(byte[] value)
        Constructs a new token with the given non-null ip4 value. If a null valued token is desired, use NULL.
        Parameters:
        value - the ip4 address value of the token. A copy of the array will be made.
        Throws:
        NullPointerException - if the supplied array is null

      • Ip4AddressToken

        public Ip4AddressToken​(String value)
        Constructs a Ip4AddressToken with the non-null ip4 address value encoded by the given string. Should be in form #.#.#.# If a null valued token is desired, use NULL.
        Parameters:
        value - a string representing the ip4 value
        Throws:
        NullPointerException - if the supplied hexadecimal string is null

    • Method Detail

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

      • represents

        public boolean represents​(byte[] otherData)
        A 'deep equals' comparison of this token's contents to the provided raw ip4 bytes. Implementations SHOULD use this instead of equals when comparing Ip4AddressTokens to arrays; equals() will eventually stop recognizing ip4 byte arrays to comply with the general equals/hashcode contracts.
        Parameters:
        otherData - the object that we're comparing to
        Returns:
        a 'deep equals' comparison of contents with otherData

      • 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 Ip4AddressToken parse​(String value)
        Converts a string representation of a ip4 address value into a token. Should be in form #.#.#.#
        Parameters:
        value - a string representing an ip4 address
        Returns:
        a token with the specified value

      • asAddress

        public final byte[] asAddress()
        Description copied from interface: Ip4AddressValued
        Gets the contained raw IPv4 address value. The array returned is a copy of the binary data contained in the object.
        Specified by:
        asAddress in interface Ip4AddressValued
        Returns:
        the contained value as a byte[4]. If null valued, as indicated by TokenValued.isNull(), null 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