com.espertech.esper.client.soda
Enum OutputLimitUnit

java.lang.Object
  java.lang.Enum<OutputLimitUnit>
      com.espertech.esper.client.soda.OutputLimitUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OutputLimitUnit>

public enum OutputLimitUnit
extends java.lang.Enum<OutputLimitUnit>

Unit for output rate limiting.

Enum Constant Summary

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

java.lang.String	getText() Returns the text for the unit.
static OutputLimitUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OutputLimitUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static OutputLimitUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OutputLimitUnit c : OutputLimitUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static OutputLimitUnit valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getText

public java.lang.String getText()

Returns the text for the unit.

Returns:

unit text