com.tibco.cep.runtime.model.element

Interface PropertyArrayInt

public interface PropertyArrayInt

Property that contains zero, one, or multiple PropertyAtomInt.

Since:

2.0.0

Method Summary

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

Method Detail

add

int add(int value)

Creates a PropertyAtomInt with the given int and appends it to the array.

Parameters:

value - the int to add.

Returns:

the index at which the value was inserted.

Since:

2.0.0

add

void add(int index,
         int value)

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

Parameters:

index - the position at which to insert.

value - the int 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

PropertyAtomInt removePropertyAtom(int value)

Removes the first PropertyAtomInt 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 intto search for in the array.

Returns:

the removed PropertyAtomInt, or null if none matched.

Since:

2.0.0

set

void set(int index,
         int value)

Sets the PropertyAtomInt at the given index to the given int. 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 int 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