com.tibco.cep.runtime.model.element

Interface PropertyArrayDateTime

public interface PropertyArrayDateTime

Property that contains zero, one, or multiple PropertyAtomDateTime.

Since:

2.0.0

Method Summary

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

Method Detail

add

int add(java.util.Calendar value)

Creates a PropertyAtomDateTime with the given Calendar and appends it to the array.

Parameters:

value - the Calendar to add.

Returns:

the index at which the value was inserted.

Since:

2.0.0

add

void add(int index,
         java.util.Calendar value)

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

Parameters:

index - the position at which to insert.

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

PropertyAtomDateTime removePropertyAtom(java.util.Calendar value)

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

Returns:

the removed PropertyAtomDateTime, or null if none matched.

Since:

2.0.0

set

void set(int index,
         java.util.Calendar value)

Sets the PropertyAtomDateTime at the given index to the given Calendar. 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 Calendar 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