Package fr.ens.biologie.genomique.eoulsan.galaxytools.elements

Class TextParameterToolElement

java.lang.Object

fr.ens.biologie.genomique.eoulsan.galaxytools.elements.AbstractToolElement

fr.ens.biologie.genomique.eoulsan.galaxytools.elements.AbstractParameterToolElement

fr.ens.biologie.genomique.eoulsan.galaxytools.elements.TextParameterToolElement

All Implemented Interfaces:

ToolElement

Direct Known Subclasses:

FloatParameterToolElement, IntegerParameterToolElement

public class TextParameterToolElement
extends AbstractParameterToolElement

This class define a text tool element parameter.

Since:

2.0

Author:

Laurent Jourdren

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	The Constant TYPE.

Fields inherited from interface fr.ens.biologie.genomique.eoulsan.galaxytools.elements.ToolElement

SEP

Constructor Summary

Constructors

Constructor	Description
TextParameterToolElement(ToolInfo toolInfo, Element param)	Instantiates a new text tool element parameter.
TextParameterToolElement(ToolInfo toolInfo, Element param, String nameSpace)	Instantiates a new text tool element parameter.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Gets the value.
boolean	isParameterValueValid()	Test if the parameter value is valid
boolean	isSet()	Checks if the value has been set (is not the default value).
void	setValue(String value)	Sets the value.

Methods inherited from class fr.ens.biologie.genomique.eoulsan.galaxytools.elements.AbstractToolElement

equals, getHelp, getLabel, getName, getShortName, getType, getValidatedName, hashCode, isOptional, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE

public static final String TYPE

The Constant TYPE.

See Also:

• Constant Field Values

Constructor Details

TextParameterToolElement

public TextParameterToolElement(ToolInfo toolInfo,
 Element param)
                         throws EoulsanException

Instantiates a new text tool element parameter.

Parameters:

toolInfo - the ToolInfo object

param - the parameter

Throws:

EoulsanException - if an error occurs while setting the value

TextParameterToolElement

public TextParameterToolElement(ToolInfo toolInfo,
 Element param,
 String nameSpace)
                         throws EoulsanException

Instantiates a new text tool element parameter.

Parameters:

toolInfo - the ToolInfo object

param - the parameter

nameSpace - the name space

Throws:

EoulsanException - if an error occurs while setting the value

Method Details

isParameterValueValid

public boolean isParameterValueValid()

Description copied from class: AbstractParameterToolElement

Test if the parameter value is valid

Specified by:

isParameterValueValid in class AbstractParameterToolElement

Returns:

true if the paramter value is valid

getValue

public String getValue()

Description copied from interface: ToolElement

Gets the value.

Returns:

the value

isSet

public boolean isSet()

Description copied from class: AbstractParameterToolElement

Checks if the value has been set (is not the default value).

Specified by:

isSet in class AbstractParameterToolElement

Returns:

true if the value has been set

setValue

public void setValue(String value)
              throws EoulsanException

Description copied from interface: ToolElement

Sets the value.

Parameters:

value - the value

Throws:

EoulsanException - the eoulsan exception