Package com.espertech.esper.common.client.soda

Enum Class OutputLimitUnit

java.lang.Object

java.lang.Enum<OutputLimitUnit>

com.espertech.esper.common.client.soda.OutputLimitUnit

All Implemented Interfaces:

Serializable, Comparable<OutputLimitUnit>, Constable

public enum OutputLimitUnit
extends Enum<OutputLimitUnit>

Unit for output rate limiting.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER	The unit representing just after a time period or after a number of events.
CONTEXT_PARTITION_TERM	The unit representing that output occurs when the context partition terminates.
CRONTAB_EXPRESSION	The unit representing a crontab-at-expression.
EVENTS	The number of events unit.
TIME_PERIOD	The time period unit.
WHEN_EXPRESSION	The unit representing a when-expression.

Method Summary

Modifier and Type	Method	Description
String	getText()	Returns the text for the unit.
static OutputLimitUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutputLimitUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIME_PERIOD

public static final OutputLimitUnit TIME_PERIOD

The time period unit.

EVENTS

public static final OutputLimitUnit EVENTS

The number of events unit.

WHEN_EXPRESSION

public static final OutputLimitUnit WHEN_EXPRESSION

The unit representing a when-expression.

CRONTAB_EXPRESSION

public static final OutputLimitUnit CRONTAB_EXPRESSION

The unit representing a crontab-at-expression.

AFTER

public static final OutputLimitUnit AFTER

The unit representing just after a time period or after a number of events.

CONTEXT_PARTITION_TERM

public static final OutputLimitUnit CONTEXT_PARTITION_TERM

The unit representing that output occurs when the context partition terminates.

Method Details

values

public static OutputLimitUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OutputLimitUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getText

public String getText()

Returns the text for the unit.

Returns:

unit text