com.sk89q.worldedit.util.command

Class SimpleParameter

java.lang.Object

com.sk89q.worldedit.util.command.SimpleParameter

All Implemented Interfaces:

Parameter

Direct Known Subclasses:

ParameterData

public class SimpleParameter
extends Object
implements Parameter

A simple implementation of Parameter that has setters.

Constructor Summary

Constructors

Constructor and Description
SimpleParameter() Create a new parameter with no name defined yet.
SimpleParameter(String name) Create a new parameter of the given name.

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.
void	setDefaultValue(String[] defaultValue) Set the default value.
void	setFlag(Character flag, boolean isValue) Set the flag used by this parameter.
void	setName(String name) Set the name of the parameter.
void	setOptional(boolean isOptional) Set whether this parameter is optional.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleParameter

public SimpleParameter()

Create a new parameter with no name defined yet.

SimpleParameter

public SimpleParameter(String name)

Create a new parameter of the given name.

Parameters:

name - the name

Method Detail

getName

public String getName()

Description copied from interface: Parameter

The name of the parameter.

Specified by:

getName in interface Parameter

Returns:

the name

setName

public void setName(String name)

Set the name of the parameter.

Parameters:

name - the parameter name

getFlag

public Character getFlag()

Description copied from interface: Parameter

Get the flag associated with this parameter.

Specified by:

getFlag in interface Parameter

Returns:

the flag, or null if there is no flag associated

See Also:

Parameter.isValueFlag()

isValueFlag

public boolean isValueFlag()

Description copied from interface: Parameter

Return whether the flag is a value flag.

Specified by:

isValueFlag in interface Parameter

Returns:

true if the flag is a value flag

See Also:

Parameter.getFlag()

setFlag

public void setFlag(Character flag,
                    boolean isValue)

Set the flag used by this parameter.

Parameters:

flag - the flag, or null if there is no flag

isValue - true if the flag is a value flag

isOptional

public boolean isOptional()

Description copied from interface: Parameter

Get whether this parameter is optional.

Specified by:

isOptional in interface Parameter

Returns:

true if the parameter does not have to be specified

setOptional

public void setOptional(boolean isOptional)

Set whether this parameter is optional.

Parameters:

isOptional - true if this parameter is optional

getDefaultValue

public String[] getDefaultValue()

Description copied from interface: Parameter

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

Specified by:

getDefaultValue in interface Parameter

Returns:

a default value, or null if none is set

setDefaultValue

public void setDefaultValue(String[] defaultValue)

Set the default value.

Parameters:

defaultValue - a default value, or null if none

toString

public String toString()

Overrides:

toString in class Object