com.caplin.server

Enum ThrottleCommand

java.lang.Object

java.lang.Enum<ThrottleCommand>

com.caplin.server.ThrottleCommand

All Implemented Interfaces:

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

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

Defines the available Throttle Commands.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Restore the throttle level to the configured default value.
DOWN Decrease the throttle (this will result in more updates being sent to the client)
MAX Set the throttle level to the maximum.
MIN Reduce the throttle level to the minimum.
START Restore the throttle level to the level that was applied prior to the stop command being issued.
STOP Stop any updates that could be throttled from being sent to client.
UP Increase the throttle (this will result in fewer updates being sent to the client).

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	toString()
static ThrottleCommand	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ThrottleCommand[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UP

public static final ThrottleCommand UP

Increase the throttle (this will result in fewer updates being sent to the client).

DOWN

public static final ThrottleCommand DOWN

Decrease the throttle (this will result in more updates being sent to the client)

MIN

public static final ThrottleCommand MIN

Reduce the throttle level to the minimum.

MAX

public static final ThrottleCommand MAX

Set the throttle level to the maximum.

STOP

public static final ThrottleCommand STOP

Stop any updates that could be throttled from being sent to client.

START

public static final ThrottleCommand START

Restore the throttle level to the level that was applied prior to the stop command being issued.

DEFAULT

public static final ThrottleCommand DEFAULT

Restore the throttle level to the configured default value.

Method Detail

values

public static ThrottleCommand[] 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 (ThrottleCommand c : ThrottleCommand.values())
    System.out.println(c);

Returns:

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

valueOf

public static ThrottleCommand 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ThrottleCommand>