org.lsst.ccs.command

Interface DictionaryArgument

All Superinterfaces:

Serializable

public interface DictionaryArgument
extends Serializable

Encapsulate the dictionary information about a single argument. If the parameter is an Enum, we capture the list of legal values (we do not want to require that the Enum class itself be available in a remote client).

Author:

tonyj

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedValues() Get the list of allowed values for this DictionaryArgument.
String	getDefaultValue()
String	getDescription()
String	getName()
String	getSimpleType() Get the simple type of this parameter
String	getType() Get the type of this parameter
default boolean	hasDefaultValue()

Method Detail

getDescription

String getDescription()

getName

String getName()

getSimpleType

String getSimpleType()

Get the simple type of this parameter

Returns:

The simple type (e.g. String)

getType

String getType()

Get the type of this parameter

Returns:

The full canonical type (e.g. java.lang.String)

getAllowedValues

List<String> getAllowedValues()

Get the list of allowed values for this DictionaryArgument. This list will be used during tab completion.

Returns:

The List of allowed values. Empty if no values are available.

getDefaultValue

String getDefaultValue()

hasDefaultValue

default boolean hasDefaultValue()