org.glyptodon.guacamole.protocols

Class ProtocolParameter

java.lang.Object

org.glyptodon.guacamole.protocols.ProtocolParameter

public class ProtocolParameter
extends Object

Represents a parameter of a protocol.

Author:

Michael Jumper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolParameter.Type All possible types of protocol parameter.

Constructor Summary

Constructors

Constructor and Description
ProtocolParameter()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the name associated with this protocol parameter.
Collection<ProtocolParameterOption>	getOptions() Returns a mutable collection of protocol parameter options.
String	getTitle() Returns the title associated with this protocol parameter.
ProtocolParameter.Type	getType() Returns the type of this parameter.
String	getValue() Returns the value associated with this protocol parameter.
void	setName(String name) Sets the name associated with this protocol parameter.
void	setTitle(String title) Sets the title associated with this protocol parameter.
void	setType(ProtocolParameter.Type type) Sets the type of this parameter.
void	setValue(String value) Sets the value associated with this protocol parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtocolParameter

public ProtocolParameter()

Method Detail

getName

public String getName()

Returns the name associated with this protocol parameter.

Returns:

The name associated with this protocol parameter.

setName

public void setName(String name)

Sets the name associated with this protocol parameter. This name must uniquely identify this parameter among the others accepted by the corresponding protocol.

Parameters:

name - The name to assign to this protocol parameter.

getTitle

public String getTitle()

Returns the title associated with this protocol parameter.

Returns:

The title associated with this protocol parameter.

setTitle

public void setTitle(String title)

Sets the title associated with this protocol parameter. The title must be a human-readable string which describes accurately this parameter.

Parameters:

title - A human-readable string describing this parameter.

getValue

public String getValue()

Returns the value associated with this protocol parameter.

Returns:

The value associated with this protocol parameter.

setValue

public void setValue(String value)

Sets the value associated with this protocol parameter. The value must be a human-readable string which describes accurately this parameter.

Parameters:

value - A human-readable string describing this parameter.

getType

public ProtocolParameter.Type getType()

Returns the type of this parameter.

Returns:

The type of this parameter.

setType

public void setType(ProtocolParameter.Type type)

Sets the type of this parameter.

Parameters:

type - The type of this parameter.

getOptions

public Collection<ProtocolParameterOption> getOptions()

Returns a mutable collection of protocol parameter options. Changes to this collection directly affect the available options.

Returns:

A mutable collection of parameter options.