com.tibco.cep.runtime.model.element

Interface PropertyArrayDouble

public interface PropertyArrayDouble

Property that contains zero, one, or multiple PropertyAtomDouble.

Since:

2.0.0

Method Summary

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

Method Detail

add

int add(double value)

Creates a PropertyAtomDouble with the given double and appends it to the array.

Parameters:

value - the double to add.

Returns:

the index at which the value was inserted.

Since:

2.0.0

add

void add(int index,
         double value)

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

Parameters:

index - the position at which to insert.

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

PropertyAtomDouble removePropertyAtom(double value)

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

Returns:

the removed PropertyAtomDouble, or null if none matched.

Since:

2.0.0

set

void set(int index,
         double value)

Sets the PropertyAtomDouble at the given index to the given double. 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 double 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