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

Class ParameterLong

java.lang.Object

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

gov.nih.mipav.model.scripting.parameters.ParameterLong

public class ParameterLong
extends Parameter

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

Field Summary

Fields

Modifier and Type	Field	Description
private long	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
ParameterLong(String paramLabel)	Creates a new ParameterLong object without any value.
ParameterLong(String paramLabel, int paramType, long paramValue)	Creates a new ParameterLong object.
ParameterLong(String paramLabel, int paramType, String paramValueString)	Creates a new ParameterLong object.
ParameterLong(String paramLabel, long paramValue)	Creates a new ParameterLong with a new value.
ParameterLong(String paramLabel, String paramTypeString, long paramValue)	Creates a new ParameterLong object.
ParameterLong(String paramLabel, String paramTypeString, String paramValueString)	Creates a new ParameterLong object.

Method Summary

Modifier and Type	Method	Description
long	getValue()	Returns the parameter value.
String	getValueString()	Returns the parameter value as a string.
void	setValue(long 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 long value

The parameter's value.

Constructor Details

ParameterLong

public ParameterLong(String paramLabel)
              throws ParserException

Creates a new ParameterLong object without any value.

Parameters:

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

Throws:

ParserException - If there is a problem creating the parameter.

ParameterLong

public ParameterLong(String paramLabel,
 long paramValue)
              throws ParserException

Creates a new ParameterLong 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.

ParameterLong

public ParameterLong(String paramLabel,
 String paramTypeString,
 long paramValue)
              throws ParserException

Creates a new ParameterLong 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.

ParameterLong

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

Creates a new ParameterLong 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.

ParameterLong

public ParameterLong(String paramLabel,
 int paramType,
 long paramValue)
              throws ParserException

Creates a new ParameterLong object.

Parameters:

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

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

paramValue - The new parameter value.

Throws:

ParserException - If there is a problem creating the parameter.

ParameterLong

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

Creates a new ParameterLong object.

Parameters:

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

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

paramValueString - The new parameter value in string form.

Throws:

ParserException - If there is a problem creating the parameter.

Method Details

getValue

public long 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(long 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.