Package com.caplin.server

Enum Class ThrottleCommand

java.lang.Object
java.lang.Enum<ThrottleCommand>
com.caplin.server.ThrottleCommand
All Implemented Interfaces:
Serializable, Comparable<ThrottleCommand>, Constable
public enum ThrottleCommand extends Enum<ThrottleCommand>
Defines the available Throttle Commands.

  • 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
    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

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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 Details

    • values

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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ThrottleCommand>