Package gov.nih.mipav.model.scripting.parameters

Class ParameterInt

java.lang.Object

gov.nih.mipav.model.scripting.parameters.Parameter

gov.nih.mipav.model.scripting.parameters.ParameterInt

public class ParameterInt
extends Parameter

A integer parameter used in either the recording or execution of a script action.

Field Summary

Fields

Modifier and Type	Field	Description
private int	value	The parameter's value.

Fields inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

PARAM_BOOLEAN, PARAM_DOUBLE, PARAM_EXTERNAL_IMAGE, PARAM_FILE, PARAM_FLOAT, PARAM_IMAGE, PARAM_INT, PARAM_LIST, PARAM_LONG, PARAM_SHORT, PARAM_STRING, PARAM_USHORT

Constructor Summary

Constructors

Constructor	Description
ParameterInt(String paramLabel)	Creates a new ParameterInt object without any value.
ParameterInt(String paramLabel, int paramValue)	Creates a new ParameterInt with a new value.
ParameterInt(String paramLabel, int paramType, int paramValue)	Creates a new ParameterInt object.
ParameterInt(String paramLabel, int paramType, String paramValueString)	Creates a new ParameterInt object.
ParameterInt(String paramLabel, String paramTypeString, int paramValue)	Creates a new ParameterInt object.
ParameterInt(String paramLabel, String paramTypeString, String paramValueString)	Creates a new ParameterInt object.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the parameter value.
String	getValueString()	Returns the parameter value as a string.
void	setValue(int paramValue)	Changes the parameter's current value.
void	setValue(String paramValueString)	Changes the parameter's current value.

Methods inherited from class gov.nih.mipav.model.scripting.parameters.Parameter

convertToString, getLabel, getParent, getParentConditionValueString, getType, getTypeFromString, getTypeString, getTypeString, isOptional, isParentConditionValueMet, isValueAssigned, setOptional, setParent, setParentCondition, setParentConditionValue, setValueAssigned

Methods inherited from class java.lang.Object

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

Field Details

value

private int value

The parameter's value.

Constructor Details

ParameterInt

public ParameterInt(String paramLabel)
             throws ParserException

Creates a new ParameterInt object without any value.

Parameters:

paramLabel - The label/name to give to this parameter.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterInt

public ParameterInt(String paramLabel,
 int paramValue)
             throws ParserException

Creates a new ParameterInt with a new value.

Parameters:

paramLabel - The label/name to give to this parameter.

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterInt

public ParameterInt(String paramLabel,
 String paramTypeString,
 int paramValue)
             throws ParserException

Creates a new ParameterInt object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramTypeString - The type of this parameter, in string form.

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterInt

public ParameterInt(String paramLabel,
 String paramTypeString,
 String paramValueString)
             throws ParserException

Creates a new ParameterInt object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramTypeString - The type of this parameter, in string form.

paramValueString - The new parameter value in string form.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterInt

public ParameterInt(String paramLabel,
 int paramType,
 int paramValue)
             throws ParserException

Creates a new ParameterInt object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramType - The type of this parameter (should be PARAM_INT).

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterInt

public ParameterInt(String paramLabel,
 int paramType,
 String paramValueString)
             throws ParserException

Creates a new ParameterInt object.

Parameters:

paramLabel - The label/name to give to this parameter.

paramType - The type of this parameter (should be PARAM_INT).

paramValueString - The new parameter value in string form.

Throws:

ParserException - If there is a problem creating the parameter.

Method Details

getValue

public int getValue()

Returns the parameter value.

Returns:

The parameter value.

getValueString

public String getValueString()

Returns the parameter value as a string.

Specified by:

getValueString in class Parameter

Returns:

The parameter value in string form.

setValue

public void setValue(String paramValueString)
              throws ParserException

Changes the parameter's current value.

Specified by:

setValue in class Parameter

Parameters:

paramValueString - The new parameter value in String form.

Throws:

ParserException - If there is a problem changing the parameter value.

setValue

public void setValue(int paramValue)
              throws ParserException

Changes the parameter's current value.

Parameters:

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem changing the parameter value.