com.tibco.cep.runtime.model.element

Interface PropertyAtomString

public interface PropertyAtomString

Property that contains one String.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getString() Gets the current value of this property.
java.lang.String	getString(long time) Gets the value that property had at the given time.
java.lang.String	getStringAtIdx(int idx) Gets the value of this property at the given history index.
boolean	setString(java.lang.String value) Sets the current value of this property.
boolean	setString(java.lang.String value, long time) Sets the value of this property with a given time.

Method Detail

getString

java.lang.String getString()

Gets the current value of this property.

Returns:

the current value of this property.

Since:

2.0.0

getString

java.lang.String getString(long time)

Gets the value that property had at the given time.

Parameters:

time - a time expressed in number of milliseconds since the epoch.

Returns:

a String value.

Throws:

PropertyException - if the value at the given time is unknown.

Since:

2.0.0

getStringAtIdx

java.lang.String getStringAtIdx(int idx)

Gets the value of this property at the given history index.

Parameters:

idx - index in the history of this property.

Returns:

the value of this property at the given index.

Throws:

PropertyException - if the index is invalid.

Since:

2.0.0

See Also:

Property#getHistoryPolicy(), Property#getHistorySize()

setString

boolean setString(java.lang.String value)

Sets the current value of this property.

Parameters:

value - the value to set

Returns:

true if a new entry was added in the history for this value.

Since:

2.0.0

See Also:

Property#getHistoryPolicy()

setString

boolean setString(java.lang.String value,
                  long time)

Sets the value of this property with a given time.

Parameters:

value - the value to set.

time - the time to associate with the value.

Returns:

true if a new entry was added in the history for this value.

Since:

2.0.0

See Also:

Property#getHistoryPolicy()