com.tibco.cep.runtime.model.element

Interface PropertyArrayBoolean

public interface PropertyArrayBoolean

Property that contains zero, one, or multiple PropertyAtomBoolean.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
int	add(boolean value) Creates a PropertyAtomBoolean with the given value and appends it to the end of the array
void	add(int index, boolean value) Creates a PropertyAtomBoolean with the given value and inserts it at the specified position in the array.
PropertyAtomBoolean	removePropertyAtom(boolean value) Removes the first occurrence of PropertyAtomBoolean in this array which has the given value, and returns it.
void	set(int index, boolean value) Sets the PropertyAtomBoolean at index the given index to the given value.

Method Detail

add

int add(boolean value)

Creates a PropertyAtomBoolean with the given value and appends it to the end of the array

Parameters:

value - of the PropertyAtomBoolean to create.

Returns:

the index at which it is inserted.

Since:

2.0.0

add

void add(int index,
         boolean value)

Creates a PropertyAtomBoolean with the given value and inserts it at the specified position in the array. Shifts the PropertyAtomBoolean currently at that position (if any) and any subsequent PropertyAtomBoolean to the right (i.e. adds one to their indices).

Parameters:

index - at which the specified PropertyAtomBoolean is to be inserted.

value - of the PropertyAtomBoolean to be inserted.

Throws:

java.lang.IndexOutOfBoundsException - if index is invalid.

Since:

2.0.0

set

void set(int index,
         boolean value)

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

Parameters:

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

value - to set.

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid.

Since:

2.0.0

removePropertyAtom

PropertyAtomBoolean removePropertyAtom(boolean value)

Removes the first occurrence of PropertyAtomBoolean in this array which has the given value, and returns it. This method shifts all the subsequent array elements to the left (i.e. substracts one to their indices). It returns null if no PropertyAtomBoolean is found.

Parameters:

value - to search for.

Returns:

the removed PropertyAtomBoolean.

Since:

2.0.0