com.pervasive.datarush.tokens.scalar

Class Ip4AddressToken

java.lang.Object

com.pervasive.datarush.tokens.scalar.Ip4AddressToken

All Implemented Interfaces:

DataToken, Ip4AddressValued, ScalarToken, ScalarValued, TokenValued, ScalarTyped, TokenTyped, Serializable, Comparable<Ip4AddressToken>

public final class Ip4AddressToken
extends Object
implements ScalarToken, Comparable<Ip4AddressToken>

An immutable Ip4AddressValued object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Ip4AddressToken	NULL A null valued Ip4AddressToken
static Ip4AddressToken	ZERO A zero valued Ip4AddressToken
static byte[]	ZERO_VALUE The byte array representing the 0.0.0.0 ip address, the empty byte[4].

Constructor Summary

Constructors

Constructor and Description
Ip4AddressToken(byte[] value) Constructs a new token with the given non-null ip4 value.
Ip4AddressToken(Ip4AddressValued value) Constructs a new token with the ip4 address value in the given container.
Ip4AddressToken(String value) Constructs a Ip4AddressToken with the non-null ip4 address value encoded by the given string.

Method Summary

Modifier and Type	Method and Description
byte[]	asAddress() Gets the contained raw IPv4 address value.
Inet4Address	asInet4Address() Gets the contained IP address as an Inet4Address.
int	compareTo(Ip4AddressToken that)
boolean	equals(Object obj) Indicates whether another object is equal to this token.
ScalarTokenType	getType() Gets the data type of the token.
int	hashCode() Returns a hash code for the token.
boolean	isNull() Indicates whether the token is null valued.
boolean	isZero() Indicates whether the value is the zero value for the type.
static Ip4AddressToken	parse(String value) Converts a string representation of a ip4 address value into a token.
boolean	represents(byte[] otherData) A 'deep equals' comparison of this token's contents to the provided raw ip4 bytes.
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 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

compareTo

public int compareTo(Ip4AddressToken that)

Specified by:

compareTo in interface Comparable<Ip4AddressToken>

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

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 ScalarValued

Specified by:

getType in interface TokenValued

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface TokenTyped

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