org.glyptodon.guacamole.protocols

Enum ProtocolParameter.Type

java.lang.Object

java.lang.Enum<ProtocolParameter.Type>

org.glyptodon.guacamole.protocols.ProtocolParameter.Type

All Implemented Interfaces:

Serializable, Comparable<ProtocolParameter.Type>

Enclosing class:

ProtocolParameter

public static enum ProtocolParameter.Type
extends Enum<ProtocolParameter.Type>

All possible types of protocol parameter.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN A boolean parameter, whose value is either blank or "true".
ENUM An enumerated parameter, whose legal values are fully enumerated by a provided, finite list.
MULTILINE A text parameter that can span more than one line.
NUMERIC A numeric parameter, whose value must contain only digits.
PASSWORD A password parameter, whose value is sensitive and must be hidden.
TEXT A text parameter, accepting arbitrary values.
USERNAME A username parameter.

Method Summary

Methods

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

TEXT

public static final ProtocolParameter.Type TEXT

A text parameter, accepting arbitrary values.

USERNAME

public static final ProtocolParameter.Type USERNAME

A username parameter. This parameter type generally behaves identically to arbitrary text parameters, but has semantic differences. If credential pass-through is in use, the value for this parameter may be automatically provided using the credentials originally used by the user to authenticate.

PASSWORD

public static final ProtocolParameter.Type PASSWORD

A password parameter, whose value is sensitive and must be hidden. If credential pass-through is in use, the value for this parameter may be automatically provided using the credentials originally used by the user to authenticate.

NUMERIC

public static final ProtocolParameter.Type NUMERIC

A numeric parameter, whose value must contain only digits.

BOOLEAN

public static final ProtocolParameter.Type BOOLEAN

A boolean parameter, whose value is either blank or "true".

ENUM

public static final ProtocolParameter.Type ENUM

An enumerated parameter, whose legal values are fully enumerated by a provided, finite list.

MULTILINE

public static final ProtocolParameter.Type MULTILINE

A text parameter that can span more than one line.

Method Detail

values

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

Returns:

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

valueOf

public static ProtocolParameter.Type 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