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

Class Ip4AddressRegister

java.lang.Object
com.pervasive.datarush.tokens.scalar.Ip4AddressRegister
All Implemented Interfaces:
DataRegister, Ip4AddressSettable, Ip4AddressValued, ScalarRegister, ScalarSettable, ScalarValued, TokenSettable, TokenValued, ScalarTyped, TokenTyped, Serializable
public final class Ip4AddressRegister extends Object implements ScalarRegister, Ip4AddressSettable
A mutable Ip4AddressValued object.
See Also:

  • Constructor Details

    • Ip4AddressRegister

      public Ip4AddressRegister()
      Creates a new null-valued register.

  • Method Details

    • 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(byte[] value)
      Description copied from interface: Ip4AddressSettable
      Sets the container to the given raw ip value.
      Specified by:
      set in interface Ip4AddressSettable
      Parameters:
      value - raw address value to which to set the container

    • set

      public void set(Inet4Address value)
      Description copied from interface: Ip4AddressSettable
      Sets the container to the given Inet4Address value.
      Specified by:
      set in interface Ip4AddressSettable
      Parameters:
      value - Inet4Address 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

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

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

    • asInet4Address

      public final Inet4Address asInet4Address()
      Description copied from interface: Ip4AddressValued
      Gets the contained IP address as an Inet4Address.
      Specified by:
      asInet4Address in interface Ip4AddressValued
      Returns:
      the contained value as a Inet4Address. 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.

    • 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