com.sk89q.intake

Interface Parameter

All Known Implementing Classes:

ParameterData, SettableParameter

public interface Parameter

Describes a parameter utilized by a command.

See Also:

Description

Method Summary

Modifier and Type	Method and Description
String[]	getDefaultValue() Get the default value as a string to be parsed by the binding.
Character	getFlag() Get the flag associated with this parameter.
String	getName() The name of the parameter.
boolean	isOptional() Get whether this parameter is optional.
boolean	isValueFlag() Return whether the flag is a value flag.

Method Detail

getName

String getName()

The name of the parameter.

Returns:

the name

getFlag

Character getFlag()

Get the flag associated with this parameter.

Returns:

the flag, or null if there is no flag associated

See Also:

isValueFlag()

isValueFlag

boolean isValueFlag()

Return whether the flag is a value flag.

Returns:

true if the flag is a value flag

See Also:

getFlag()

isOptional

boolean isOptional()

Get whether this parameter is optional.

Returns:

true if the parameter does not have to be specified

getDefaultValue

String[] getDefaultValue()

Get the default value as a string to be parsed by the binding.

Returns:

a default value, or null if none is set