com.caplin.streamlink

Enum ThrottleCommand

java.lang.Object

java.lang.Enum<ThrottleCommand>

com.caplin.streamlink.ThrottleCommand

All Implemented Interfaces:

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

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

Enumeration that defines the available throttle levels and throttle commands.

A ThrottleCommand is passed as a parameter to the throttleSubject() and throttleEverything() methods of StreamLink.

For an explanation of throttling, refer the Throttling section of the document StreamLink Overview.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEF Set the throttle level to the default level.
DOWN Decrease the throttle level.
MAX Set the throttle level to the maximum amount of throttling.
MIN Set the throttle level to the minimum amount of throttling.
START Start sending updates to the client again.
STOP Stop sending updates to the client.
UP Increase the throttle level.

Method Summary

Methods

Modifier and Type	Method and Description
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, toString, 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 level.

DOWN

public static final ThrottleCommand DOWN

Decrease the throttle level.

MIN

public static final ThrottleCommand MIN

Set the throttle level to the minimum amount of throttling.

MAX

public static final ThrottleCommand MAX

Set the throttle level to the maximum amount of throttling.

STOP

public static final ThrottleCommand STOP

Stop sending updates to the client.

START

public static final ThrottleCommand START

Start sending updates to the client again.

DEF

public static final ThrottleCommand DEF

Set the throttle level to the default level.

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