com.drdanick.McRKit.api
Enum RTKInterface.CommandType

java.lang.Object
  extended by java.lang.Enum<RTKInterface.CommandType>
      extended by com.drdanick.McRKit.api.RTKInterface.CommandType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RTKInterface.CommandType>
Enclosing class:
RTKInterface

public static enum RTKInterface.CommandType
extends java.lang.Enum<RTKInterface.CommandType>

Defines the type of action to perform.


Enum Constant Summary
DISABLE_RESTARTS
          Disables wrapper restarts WARNING: As of now this does not stop scheduled events, only the restart-on-stop event.
ENABLE_RESTARTS
          Enables wrapper restarts
FORCE_RESTART
          Recquest a forceful restart
FORCE_STOP
          Request a forceful stop
HOLD_SERVER
          Stop the server until UNHOLD_SERVER is called
RESCHEDULE_RESTART
          Reschedule the next restart.
RESTART
          Request a restart
UNHOLD_SERVER
          Unhold and start a held server
VERSION
          Request the wrapper version
 
Method Summary
static RTKInterface.CommandType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static RTKInterface.CommandType[] 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

RESTART

public static final RTKInterface.CommandType RESTART
Request a restart


FORCE_RESTART

public static final RTKInterface.CommandType FORCE_RESTART
Recquest a forceful restart


FORCE_STOP

public static final RTKInterface.CommandType FORCE_STOP
Request a forceful stop


VERSION

public static final RTKInterface.CommandType VERSION
Request the wrapper version


DISABLE_RESTARTS

public static final RTKInterface.CommandType DISABLE_RESTARTS
Disables wrapper restarts WARNING: As of now this does not stop scheduled events, only the restart-on-stop event.


ENABLE_RESTARTS

public static final RTKInterface.CommandType ENABLE_RESTARTS
Enables wrapper restarts


HOLD_SERVER

public static final RTKInterface.CommandType HOLD_SERVER
Stop the server until UNHOLD_SERVER is called


UNHOLD_SERVER

public static final RTKInterface.CommandType UNHOLD_SERVER
Unhold and start a held server


RESCHEDULE_RESTART

public static final RTKInterface.CommandType RESCHEDULE_RESTART
Reschedule the next restart. NOTE: The rescheduled restart time String is a required parameter and must be supplied when calling executeCommand.

See Also:
RTKInterface.executeCommand(com.drdanick.McRKit.api.RTKInterface.CommandType, java.lang.String)
Method Detail

values

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

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

valueOf

public static RTKInterface.CommandType 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