net.maizegenetics.plugindef

Class PluginParameter<T>

net.maizegenetics.plugindef.PluginParameter<T>

public class PluginParameter<T>

Defines the attributes of parameters to be used in the plugins

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,
                       java.util.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<java.lang.String> getLabelInstance(java.lang.String label)

guiName

public java.lang.String guiName()

units

public java.lang.String units()

cmdLineName

public java.lang.String cmdLineName()

description

public java.lang.String description()

hasRange

public boolean hasRange()

rangeToString

public java.lang.String rangeToString()

rangeToString

public java.lang.String rangeToString(boolean friendly)

possibleValuesString

public java.lang.String possibleValuesString(boolean friendly)

acceptsValue

public boolean acceptsValue(java.lang.Object value)

acceptsValue

public boolean acceptsValue(java.lang.String input)

value

public T value()

defaultValue

public T defaultValue()

required

public boolean required()

valueType

public java.lang.Class<T> valueType()

parameterType

public net.maizegenetics.plugindef.PluginParameter.PARAMETER_TYPE parameterType()

dependentOnParameter

public PluginParameter<?> dependentOnParameter()

dependentOnParameterValue

public java.lang.Object[] dependentOnParameterValue()

hasPossibleValues

public boolean hasPossibleValues()

possibleValues

public java.util.List<T> possibleValues()

isEmpty

public boolean isEmpty()