net.maizegenetics.plugindef

Class PluginParameter<T>

java.lang.Object

net.maizegenetics.plugindef.PluginParameter<T>

Type Parameters:

T -

public final class PluginParameter<T>
extends Object

Defines the attributes of parameters to be used in the plugins

Author:

Ed Buckler, Terry Casstevens

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginParameter.Builder<T>
static class	PluginParameter.PARAMETER_TYPE

Constructor Summary

Constructors

Constructor and Description
PluginParameter(PluginParameter<T> oldParameter, List<T> possibleValues) Use this to change the possible values of a PluginParameter built as objectListSingleSelect().
PluginParameter(PluginParameter<T> oldParameter, T newValue) Use these to change the value of an existing parameter, e.g.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsValue(Object value)
boolean	acceptsValue(String input)
String	cmdLineName()
T	defaultValue()
PluginParameter<?>	dependentOnParameter()
Object[]	dependentOnParameterValue()
String	description()
static PluginParameter<String>	getLabelInstance(String label)
String	guiName()
boolean	hasPossibleValues()
boolean	hasRange()
boolean	isEmpty()
PluginParameter.PARAMETER_TYPE	parameterType()
List<T>	possibleValues()
String	possibleValuesString(boolean friendly)
String	rangeToString()
String	rangeToString(boolean friendly)
boolean	required()
String	units()
T	value()
Class<T>	valueType()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginParameter

public PluginParameter(PluginParameter<T> oldParameter,
                       T newValue)

Use these to change the value of an existing parameter, e.g. after a user changes the value. Otherwise use the Builder to create the parameter

Parameters:

oldParameter -

newValue -

PluginParameter

public PluginParameter(PluginParameter<T> oldParameter,
                       List<T> possibleValues)

Use this to change the possible values of a PluginParameter built as objectListSingleSelect().

Parameters:

oldParameter - old plugin parameter

possibleValues - new values

Method Detail

getLabelInstance

public static PluginParameter<String> getLabelInstance(String label)

guiName

public String guiName()

units

public String units()

cmdLineName

public String cmdLineName()

description

public String description()

hasRange

public boolean hasRange()

rangeToString

public String rangeToString()

rangeToString

public String rangeToString(boolean friendly)

possibleValuesString

public String possibleValuesString(boolean friendly)

acceptsValue

public boolean acceptsValue(Object value)

acceptsValue

public boolean acceptsValue(String input)

value

public T value()

defaultValue

public T defaultValue()

required

public boolean required()

valueType

public Class<T> valueType()

parameterType

public PluginParameter.PARAMETER_TYPE parameterType()

dependentOnParameter

public PluginParameter<?> dependentOnParameter()

dependentOnParameterValue

public Object[] dependentOnParameterValue()

hasPossibleValues

public boolean hasPossibleValues()

possibleValues

public List<T> possibleValues()

isEmpty

public boolean isEmpty()