Module datarush.library

Package com.pervasive.datarush.sequences.scalar

Class Ip4AddressTokenList

java.lang.Object

com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

com.pervasive.datarush.sequences.scalar.Ip4AddressTokenList

All Implemented Interfaces:

MutableTokenSequence, Ip4AddressTokenSequence, MutableIp4AddressTokenSequence, MutableScalarTokenSequence, ScalarTokenAppendable, ScalarTokenSequence, TokenAppendable, TokenSequence, ScalarTyped, TokenTyped

public final class Ip4AddressTokenList
extends AbstractScalarTokenSequence
implements MutableIp4AddressTokenSequence

Primary implementation of MutableIp4AddressTokenSequence.

See Also:

TokenTypeConstant.IP4ADDRESS

Constructor Summary

Constructors

Constructor	Description
Ip4AddressTokenList(int initialCapacity)	Creates an empty array of ip4address tokens

Method Summary

Modifier and Type	Method	Description
void	append(byte[] value)	Appends the specified ip4address value to this sequence.
void	append(byte[] value, int count)	Appends the specified ip4address value to this sequence multiple times.
void	append(int value)
void	fill(int start, int length, byte[] value)	Sets the tokens in the specified subsequence to the given ip4address value.
void	fillValue(int start, int length, TokenValued value)	Sets the tokens in the specified subsequence to the given value.
byte[]	getAddress(int i)	Gets the value of the specified token as a raw IPv4 address value.
Inet4Address	getInetAddress(int i)	Gets the value of the specified token as an Inet4Address value.
Ip4AddressValued	getToken(int index)	Gets the value at the specified position.
Ip4AddressSettable	getTokenSetter(int index)	Returns a mutator for the given index.
ScalarTokenType	getType()	Gets the data type of the tokens in the sequence.
void	getValues(int index, int[] values, boolean[] nullFlags, int offset, int length)	Gets the values and null indicators for a range of tokens.
boolean	isZero(int index)	Indicates whether the specified token has a zero value.
Ip4AddressValuedIterator	newValueIterator()	Creates an iterator over the non-null values of this sequence.
void	set(int index, byte[] value)	Sets the token at the specified position to the given raw ip4address value.
void	set(int index, int value)	Sets the token at the specified position to the given raw ip4address value as an integer.
void	set(int index, Inet4Address value)	Sets the token at the specified position to the given Inet4Address value.
void	setNull(int index)	Sets the token at the specified position to be null valued.
void	setNull(int start, int length)	Sets the tokens in the specified subsequence to be null valued.
void	setValue(int index, TokenValued value)	Sets the token at the specified position to the given value.
void	setValues(int start, TokenSequence values, int offset, int length)	Sets the tokens in the specified subsequence of the array to the corresponding values from a subsequence of the given source sequence.
void	setZero(int index)	Sets the token at the specified position to be zero valued.
void	setZero(int start, int length)	Sets the tokens in the specified subsequence to be zero valued.

Methods inherited from class com.pervasive.datarush.sequences.scalar.AbstractScalarTokenSequence

append, append, append, append, appendNull, appendNull, appendZero, appendZero, capacity, compareElement, compareElements, ensureCanonical, getElementComparator, getModificationCount, hashCode, isNull, isNull, map, remaining, reset, size, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.pervasive.datarush.sequences.scalar.MutableScalarTokenSequence

ensureCanonical, getModificationCount

Methods inherited from interface com.pervasive.datarush.sequences.MutableTokenSequence

appendNull, appendNull, appendZero, appendZero, reset

Methods inherited from interface com.pervasive.datarush.sequences.scalar.ScalarTokenSequence

isNull

Methods inherited from interface com.pervasive.datarush.sequences.TokenAppendable

append, append, append, append

Methods inherited from interface com.pervasive.datarush.sequences.TokenSequence

compareElement, compareElements, getElementComparator, hashCode, isNull, size, toString

Constructor Detail

Ip4AddressTokenList

public Ip4AddressTokenList(int initialCapacity)

Creates an empty array of ip4address tokens

Parameters:

initialCapacity - the initial capacity.

Method Detail

getType

public ScalarTokenType getType()

Description copied from interface: ScalarTokenSequence

Gets the data type of the tokens in the sequence.

Specified by:

getType in interface ScalarTokenSequence

Specified by:

getType in interface ScalarTyped

Specified by:

getType in interface TokenTyped

Returns:

the token data type

getAddress

public byte[] getAddress(int i)

Description copied from interface: Ip4AddressTokenSequence

Gets the value of the specified token as a raw IPv4 address value.

A copy of the value is returned.

Specified by:

getAddress in interface Ip4AddressTokenSequence

Parameters:

i - the position of the token in the sequence

Returns:

the value of the token. If the token is null valued, null is returned.

getInetAddress

public Inet4Address getInetAddress(int i)

Description copied from interface: Ip4AddressTokenSequence

Gets the value of the specified token as an Inet4Address value.

Specified by:

getInetAddress in interface Ip4AddressTokenSequence

Parameters:

i - the position of the token in the sequence

Returns:

the value of the token. If the token is null valued, null is returned.

getToken

public Ip4AddressValued getToken(int index)

Description copied from interface: TokenSequence

Gets the value at the specified position.

Specified by:

getToken in interface Ip4AddressTokenSequence

Specified by:

getToken in interface ScalarTokenSequence

Specified by:

getToken in interface TokenSequence

Parameters:

index - the index of the token

Returns:

the value

getTokenSetter

public Ip4AddressSettable getTokenSetter(int index)

Description copied from interface: MutableTokenSequence

Returns a mutator for the given index.

Specified by:

getTokenSetter in interface MutableIp4AddressTokenSequence

Specified by:

getTokenSetter in interface MutableScalarTokenSequence

Specified by:

getTokenSetter in interface MutableTokenSequence

Parameters:

index - the position

Returns:

a mutator for the given index.

getValues

public void getValues(int index,
                      int[] values,
                      boolean[] nullFlags,
                      int offset,
                      int length)

Description copied from interface: Ip4AddressTokenSequence

Gets the values and null indicators for a range of tokens.

Specified by:

getValues in interface Ip4AddressTokenSequence

Parameters:

index - the starting index of the range

values - an array into which to place element values

nullFlags - an array into which to place null indicator values

offset - the starting offset into the target arrays. That is, elements[offset] and nulls[offset] will get the value and null indicator respectively of the token at position start, and so on.

length - number of tokens to get

setNull

public void setNull(int index)

Description copied from interface: MutableTokenSequence

Sets the token at the specified position to be null valued.

Specified by:

setNull in interface MutableTokenSequence

Parameters:

index - the position of the token in the array

setNull

public void setNull(int start,
                    int length)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence to be null valued.

Specified by:

setNull in interface MutableTokenSequence

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

setZero

public void setZero(int index)

Description copied from interface: MutableTokenSequence

Sets the token at the specified position to be zero valued.

Specified by:

setZero in interface MutableTokenSequence

Parameters:

index - the position of the token in the array

setZero

public void setZero(int start,
                    int length)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence to be zero valued.

Specified by:

setZero in interface MutableTokenSequence

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

isZero

public final boolean isZero(int index)

Description copied from interface: ScalarTokenSequence

Indicates whether the specified token has a zero value.

Specified by:

isZero in interface ScalarTokenSequence

Parameters:

index - the index of the token

Returns:

true if the element is zero, false otherwise

newValueIterator

public Ip4AddressValuedIterator newValueIterator()

Description copied from interface: TokenSequence

Creates an iterator over the non-null values of this sequence. The iterator will automatically be reset as modifications are made to the sequence.

Specified by:

newValueIterator in interface Ip4AddressTokenSequence

Specified by:

newValueIterator in interface ScalarTokenSequence

Specified by:

newValueIterator in interface TokenSequence

Returns:

an newly-created iterator over the non-null values of this sequence.

fill

public void fill(int start,
                 int length,
                 byte[] value)

Sets the tokens in the specified subsequence to the given ip4address value.

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

value - the raw ip4address value to which to set the tokens

setValue

public void setValue(int index,
                     TokenValued value)

Description copied from interface: MutableTokenSequence

Sets the token at the specified position to the given value.

Specified by:

setValue in interface MutableTokenSequence

Parameters:

index - the position of the token in the array

value - the value to which to set the token. This value must be of an appropriate type for the array.

fillValue

public void fillValue(int start,
                      int length,
                      TokenValued value)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence to the given value.

Specified by:

fillValue in interface MutableTokenSequence

Parameters:

start - the starting index of the subsequence in the array

length - the length of the subsequence

value - the value to which to set the tokens. This value must be of an appropriate type for the array

setValues

public void setValues(int start,
                      TokenSequence values,
                      int offset,
                      int length)

Description copied from interface: MutableTokenSequence

Sets the tokens in the specified subsequence of the array to the corresponding values from a subsequence of the given source sequence.

Specified by:

setValues in interface MutableTokenSequence

Parameters:

start - the starting index of the subsequence in the array

values - the source sequence. This sequence must be of an appropriate type for the array.

offset - the starting index in the source sequence. Corresponding values will be taken relative to this position. That is, the value of the token at position offset in values will be assigned to the token at position start, and so on.

length - the number of tokens to copy

append

public void append(int value)

append

public void append(byte[] value)

Description copied from interface: MutableIp4AddressTokenSequence

Appends the specified ip4address value to this sequence.

A copy of the input will be made.

Specified by:

append in interface MutableIp4AddressTokenSequence

Parameters:

value - the value to append. If null, this is equivalent to appendNull().

append

public void append(byte[] value,
                   int count)

Description copied from interface: MutableIp4AddressTokenSequence

Appends the specified ip4address value to this sequence multiple times.

A copy of the input will be made.

Specified by:

append in interface MutableIp4AddressTokenSequence

Parameters:

value - the value to append. If null, this is equivalent to appendNull(count).

count - the number of copies to append.

set

public void set(int index,
                int value)

Description copied from interface: MutableIp4AddressTokenSequence

Sets the token at the specified position to the given raw ip4address value as an integer.

Specified by:

set in interface MutableIp4AddressTokenSequence

Parameters:

index - the position of the token in the array

value - the ip4address as an integer to which to set the token. Passing null is equivalent to calling setNull(index).

set

public void set(int index,
                byte[] value)

Description copied from interface: MutableIp4AddressTokenSequence

Sets the token at the specified position to the given raw ip4address value.

Specified by:

set in interface MutableIp4AddressTokenSequence

Parameters:

index - the position of the token in the array

value - the raw ip4address value to which to set the token. Passing null is equivalent to calling setNull(index).

set

public void set(int index,
                Inet4Address value)

Description copied from interface: MutableIp4AddressTokenSequence

Sets the token at the specified position to the given Inet4Address value.

Specified by:

set in interface MutableIp4AddressTokenSequence

Parameters:

index - the position of the token in the array

value - the Inet4Address value to which to set the token. Passing null is equivalent to calling setNull(index).