edu.jhu.ece.iacl.jist.pipeline.parameter
Class ParamBoolean

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.PipePort<T>
      edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel<java.lang.Boolean>
          edu.jhu.ece.iacl.jist.pipeline.parameter.ParamBoolean

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<ParamModel>

public class ParamBoolean
extends ParamModel<java.lang.Boolean>

Boolean Parameter.

Author:

Blake Lucas

Nested Class Summary

Nested classes/interfaces inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort

PipePort.PortListener, PipePort.type

Field Summary

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel

cliTag, description, factory, hidden, label, loadAndSaveOnValidate, mandatory, shortLabel

Fields inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort

connectible, gport, incomingConnectors, listeners, maxIncoming, maxOutgoing, outgoingConnectors, owner, portType, useWire

Constructor Summary

ParamBoolean()
Default constructor.

ParamBoolean(boolean value)
Create a new boolean parameter with a default value.

ParamBoolean(java.lang.String name)
Construct new boolean parameter with a default value of false.

ParamBoolean(java.lang.String name, boolean value)
Create a new boolean parameter with a default value.

Method Summary

ParamBoolean	clone() Clone parameter.
int	compareTo(ParamModel model) Not restriction comparison needed for boolean values.
boolean	equals(ParamModel<java.lang.Boolean> model)
java.lang.String	getHumanReadableDataType()
java.lang.Boolean	getValue() Get value.
java.lang.String	getXMLValue()
void	init() Initialize parameter.
java.lang.String	probeDefaultValue()
void	setValue(java.lang.Boolean value) The parameter value must be a boolean.
void	setXMLValue(java.lang.String arg)
java.lang.String	toString() Get description of parameter value.
void	validate() No validation necessary for boolean values.

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.parameter.ParamModel

clean, createMipavParameter, createTreeNode, dispose, getCliTag, getDescription, getFactory, getInputView, getLabel, getName, getOutputView, getShortLabel, getView, hide, importMipavParameter, importParameter, isCompatible, isConnectible, isHidden, isMandatory, loadResources, loadResources, read, read, replacePath, saveResources, setCliTag, setDescription, setFactory, setHidden, setInputView, setLabel, setLoadAndSaveOnValidate, setMandatory, setName, setOutputView, setShortLabel, toXML, write, write, writeAndFreeNow

Methods inherited from class edu.jhu.ece.iacl.jist.pipeline.PipePort

addListener, disconnect, disconnect, disconnect, disconnect, getGraphPort, getIncomingConnector, getIncomingConnectors, getIncomingPorts, getListeners, getMaxIncoming, getMaxOutgoing, getOutgoingConnector, getOutgoingConnectors, getOutgoingPorts, getOwner, getPortType, isConnected, isConnectedTo, isInputPort, isOutputPort, notifyListenersOfConnection, notifyListenersOfDisconnection, removeAllListeners, removeListener, setConnectable, setGraphPort, setMaxIncoming, setMaxOutgoing, setOwner, setPortType, setUseConnector, usingConnector

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamBoolean

public ParamBoolean()

Default constructor.

ParamBoolean

public ParamBoolean(boolean value)

Create a new boolean parameter with a default value.

Parameters:

value - default value

ParamBoolean

public ParamBoolean(java.lang.String name)

Construct new boolean parameter with a default value of false.

Parameters:

name - the name

ParamBoolean

public ParamBoolean(java.lang.String name,
                    boolean value)

Create a new boolean parameter with a default value.

Parameters:

name - parameter name

value - default value

Method Detail

clone

public ParamBoolean clone()

Clone parameter.

Specified by:

clone in class ParamModel<java.lang.Boolean>

Returns:

the param boolean

compareTo

public int compareTo(ParamModel model)

Not restriction comparison needed for boolean values.

Specified by:

compareTo in interface java.lang.Comparable<ParamModel>

Overrides:

compareTo in class ParamModel<java.lang.Boolean>

Parameters:

model - the model

Returns:

the int

getValue

public java.lang.Boolean getValue()

Get value.

Specified by:

getValue in class ParamModel<java.lang.Boolean>

Returns:

the value

init

public void init()

Initialize parameter.

Specified by:

init in class PipePort<java.lang.Boolean>

setValue

public void setValue(java.lang.Boolean value)

The parameter value must be a boolean.

Specified by:

setValue in class ParamModel<java.lang.Boolean>

Parameters:

value - parameter value

toString

public java.lang.String toString()

Get description of parameter value.

Specified by:

toString in class ParamModel<java.lang.Boolean>

Returns:

the string

validate

public void validate()
              throws InvalidParameterException

No validation necessary for boolean values.

Specified by:

validate in class ParamModel<java.lang.Boolean>

Throws:

InvalidParameterException - parameter does not meet value restrictions

equals

public boolean equals(ParamModel<java.lang.Boolean> model)

Overrides:

equals in class ParamModel<java.lang.Boolean>

getHumanReadableDataType

public java.lang.String getHumanReadableDataType()

Specified by:

getHumanReadableDataType in class ParamModel<java.lang.Boolean>

getXMLValue

public java.lang.String getXMLValue()

Specified by:

getXMLValue in class ParamModel<java.lang.Boolean>

setXMLValue

public void setXMLValue(java.lang.String arg)

Specified by:

setXMLValue in class ParamModel<java.lang.Boolean>

probeDefaultValue

public java.lang.String probeDefaultValue()

Specified by:

probeDefaultValue in class ParamModel<java.lang.Boolean>