Package org.graffiti.plugin.parameter

Class EnumParameter

java.lang.Object

org.graffiti.plugin.parameter.AbstractSingleParameter

org.graffiti.plugin.parameter.EnumParameter

All Implemented Interfaces:

Displayable, Parameter, SingleParameter

public class EnumParameter
extends AbstractSingleParameter

Constructor Summary

Constructors

Constructor	Description
EnumParameter(Enum<?> val, String name, String description)

Method Summary

Modifier and Type	Method	Description
Enum<?>[]	getAllEnumValue()	this will return all possible enum values contained in the enum stored in this object
String	getDescription()	Returns the description of the parameter.
Enum<?>	getEnumValue()
String	getName()	Returns the name of the parameter.
Object	getValue()	Returns the encapsulated object.
void	setValue(Object val)	Sets the encapsulated object.

Methods inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter

getIcon, getImage, isLeftAligned, setDescription, setLeftAligned, toString, toXMLString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EnumParameter

public EnumParameter(Enum<?> val,
String name,
String description)

Method Details

getDescription

public String getDescription()

Description copied from class: AbstractSingleParameter

Returns the description of the parameter.

Specified by:

getDescription in interface Displayable

Overrides:

getDescription in class AbstractSingleParameter

Returns:

the description of the parameter.

getName

public String getName()

Description copied from class: AbstractSingleParameter

Returns the name of the parameter.

Specified by:

getName in interface Displayable

Overrides:

getName in class AbstractSingleParameter

Returns:

the name of the parameter.

setValue

public void setValue(Object val)
              throws IllegalArgumentException

Description copied from interface: Displayable

Sets the encapsulated object.

Specified by:

setValue in interface Displayable

Overrides:

setValue in class AbstractSingleParameter

Throws:

IllegalArgumentException - thrown if val is not of the appropriate type.

getValue

public Object getValue()

Description copied from interface: Displayable

Returns the encapsulated object.

Specified by:

getValue in interface Displayable

Overrides:

getValue in class AbstractSingleParameter

Returns:

Object

getEnumValue

public Enum<?> getEnumValue()

getAllEnumValue

public Enum<?>[] getAllEnumValue()

this will return all possible enum values contained in the enum stored in this object

Returns: