com.tibco.cep.runtime.model.element

Interface PropertyArrayString

public interface PropertyArrayString

Property that contains zero, one, or multiple PropertyAtomString.

Since:

2.0.0

Method Summary

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

Method Detail

add

int add(java.lang.String value)

Creates a PropertyAtomString with the given String and appends it to the array.

Parameters:

value - the String to add.

Returns:

the index at which the value was inserted.

Since:

2.0.0

add

void add(int index,
         java.lang.String value)

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

Parameters:

index - the position at which to insert.

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

PropertyAtomString removePropertyAtom(java.lang.String value)

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

Returns:

the removed PropertyAtomString, or null if none matched.

Since:

2.0.0

set

void set(int index,
         java.lang.String value)

Sets the PropertyAtomString at the given index to the given String. 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 String 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