com.tibco.cep.runtime.model.element

Interface PropertyArrayLong

public interface PropertyArrayLong

Property that contains zero, one, or multiple PropertyAtomLong.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
void	add(int index, long value) Creates a PropertyAtomLong with the given long and inserts it into the array at the specified position.
int	add(long value) Creates a PropertyAtomLong with the given long and appends it to the array.
PropertyAtomLong	removePropertyAtom(long value) Removes the first PropertyAtomLong with the given value that is found in this array.
void	set(int index, long value) Sets the PropertyAtomLong at the given index to the given long.

Method Detail

add

int add(long value)

Creates a PropertyAtomLong with the given long and appends it to the array.

Parameters:

value - the long to add.

Returns:

the index at which the value was inserted.

Since:

2.0.0

add

void add(int index,
         long value)

Creates a PropertyAtomLong with the given long and inserts it into the array at the specified position. This method shifts the PropertyAtomLong currently at that position (if any) and any subsequent PropertyAtomLong to the right (i.e. adds one to their indices).

Parameters:

index - the position at which to insert.

value - the long to add.

Throws:

java.lang.IndexOutOfBoundsException - - if the index is less than zero or more than the size of the array.

Since:

2.0.0

removePropertyAtom

PropertyAtomLong removePropertyAtom(long value)

Removes the first PropertyAtomLong with the given value that is found in this array. This method shifts all the subsequent array elements to the left (i.e. substracts one to their indices). It returns null if no matching value is found.

Parameters:

value - the longto search for in the array.

Returns:

the removed PropertyAtomLong, or null if none matched.

Since:

2.0.0

set

void set(int index,
         long value)

Sets the PropertyAtomLong at the given index to the given long. If index == length, this method will call add(index, value) instead.

Parameters:

index - the index at which the value is to be set.

value - the long to set at the index.

Throws:

java.lang.IndexOutOfBoundsException - - if the index is less than zero or more than the current size of the array.

Since:

2.0.0