net.sourceforge.guacamole.protocol
Enum GuacamoleInstruction.Operation

java.lang.Object
  extended by java.lang.Enum<GuacamoleInstruction.Operation>
      extended by net.sourceforge.guacamole.protocol.GuacamoleInstruction.Operation
All Implemented Interfaces:
Serializable, Comparable<GuacamoleInstruction.Operation>
Enclosing class:
GuacamoleInstruction

public static enum GuacamoleInstruction.Operation
extends Enum<GuacamoleInstruction.Operation>

The operation performed by a particular Guacamole instruction. Each Operation is associated with a unique opcode.


Enum Constant Summary
CLIENT_CONNECT
          Message sent from client to server specifying which argument values correspond to the arguments required by the selected protocol.
CLIENT_SELECT
          Message sent from client to server specifying which protocol is to be used.
SERVER_ARGS
          Message sent from server to client specifying which arguments are required by the selected protocol.
 
Method Summary
static GuacamoleInstruction.Operation fromOpcode(String opcode)
          Returns the corresponding Operation having the given opcode, if any.
 String getOpcode()
          Returns the unique opcode associated with this Operation.
static GuacamoleInstruction.Operation valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GuacamoleInstruction.Operation[] 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

CLIENT_SELECT

public static final GuacamoleInstruction.Operation CLIENT_SELECT
Message sent from client to server specifying which protocol is to be used.


CLIENT_CONNECT

public static final GuacamoleInstruction.Operation CLIENT_CONNECT
Message sent from client to server specifying which argument values correspond to the arguments required by the selected protocol.


SERVER_ARGS

public static final GuacamoleInstruction.Operation SERVER_ARGS
Message sent from server to client specifying which arguments are required by the selected protocol.

Method Detail

values

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

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

valueOf

public static GuacamoleInstruction.Operation valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getOpcode

public String getOpcode()
Returns the unique opcode associated with this Operation.

Returns:
The unique opcode associated with this Operation.

fromOpcode

public static GuacamoleInstruction.Operation fromOpcode(String opcode)
Returns the corresponding Operation having the given opcode, if any.

Parameters:
opcode - The unique opcode associated with an Operation.
Returns:
The Operation associated with the given opcode, or null if no such Operation is defined.


Copyright © 2012. All Rights Reserved.