org.graffiti.plugin.parameter
Class BooleanParameter

java.lang.Object
  extended by org.graffiti.plugin.parameter.AbstractSingleParameter<Boolean>
      extended by org.graffiti.plugin.parameter.BooleanParameter
All Implemented Interfaces:
Serializable, Displayable<Boolean>, Parameter<Boolean>, SingleParameter<Boolean>

public class BooleanParameter
extends AbstractSingleParameter<Boolean>

Parameter that contains a Boolean value.

Version:
$Revision: 5767 $
See Also:
Serialized Form

Constructor Summary
BooleanParameter(Boolean value, String name, String description)
          Constructs a new boolean parameter.
 
Method Summary
 Boolean getBoolean()
          Returns the value of this parameter as a Boolean.
 boolean isValid()
          Returns true, if the current value is valid.
 String toXMLString()
          Returns a well-formed XML string representing the Displayable.
 
Methods inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter
canCopy, copy, getDependencyParent, getDependencyValue, getDescription, getImage, getName, getValue, isVisible, setDependency, setDescription, setObjectValue, setValue, setVisible, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BooleanParameter

public BooleanParameter(Boolean value,
                        String name,
                        String description)
Constructs a new boolean parameter.

Parameters:
value - the new Boolean value. May be null.
name - the name of the parameter.
description - the description of the parameter.
Method Detail

getBoolean

public Boolean getBoolean()
Returns the value of this parameter as a Boolean.

Returns:
the value of this parameter as a Boolean.

isValid

public boolean isValid()
Returns true, if the current value is valid.

Returns:
DOCUMENT ME!

toXMLString

public String toXMLString()
Description copied from interface: Displayable
Returns a well-formed XML string representing the Displayable. The Displayable should be reconstructable via this representation. Therefore it must at least include the type of Displayable (classname) and a representation of its value. PROBABLE FUTURE DESIGN: The Displayables themselves will provide a method to reconstruct their value from the XML representation they provided.

Specified by:
toXMLString in interface Displayable<Boolean>
Overrides:
toXMLString in class AbstractSingleParameter<Boolean>
Returns:
string holding an XML representation of this Displayable
See Also:
Displayable.toXMLString()


Generated at 2012-05-30 11:00:14 PM CEST