public class Parameter extends Object
Modifier and Type | Class and Description |
---|---|
static class |
Parameter.ParameterType |
Constructor and Description |
---|
Parameter(String id,
String name,
String description,
Parameter.ParameterType type,
String value)
Define a parameter that will be shown to the user of the tool.
|
Parameter(String id,
String name,
String description,
Parameter.ParameterType type,
String value,
boolean hidden)
Define a parameter that will be shown to the user of the tool, if hidden
is not set to true.
|
Parameter(String id,
String name,
String description,
Parameter.ParameterType type,
String value,
boolean hidden,
boolean allowEmpty)
Define a parameter that will be shown to the user of the tool, if hidden
is not set to true.
|
Parameter(String id,
String name,
String description,
String value,
boolean hidden,
boolean allowEmpty,
String... options)
Define a parameter that will be shown to the user of the tool, if hidden
is not set to true.
|
Parameter(String id,
String name,
String description,
String value,
boolean hidden,
String... options)
Define a parameter that will be shown to the user of the tool, if hidden
is not set to true.
|
Parameter(String id,
String name,
String description,
String value,
String... options)
Define a parameter that will be shown to the user of the tool.
|
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Return the description of the parameter.
|
String |
getID()
Return the id of the parameter.
|
String |
getName()
Return the name of the paraemter.
|
String[] |
getOptions()
Returns array with all allowable options.
|
Parameter.ParameterType |
getType()
Return the type of the parameter.
|
String |
getValue()
Return the value of the parameter.
|
boolean |
isAllowEmpty()
Returns true if the parameter can be empty
|
boolean |
isHidden()
Returns true if the parameter should not be shown to the user.
|
void |
setAllowEmpty(boolean allowEmpty)
Set to true if the parameter should not be shown to the user.
|
void |
setDescription(String description)
Set the description of the parameter.
|
void |
setHidden(boolean hidden)
Set to true if the parameter should not be shown to the user.
|
void |
setID(String id)
Set the id of the parameter.
|
void |
setName(String name)
Set the name of the parameter.
|
void |
setOptions(String... options)
Sets an array with all allowable options.
|
void |
setType(Parameter.ParameterType type)
Set the type of the parameter.
|
void |
setValue(String value)
Set the value of the parameter.
|
public Parameter(String id, String name, String description, Parameter.ParameterType type, String value)
id
- the id of the parameter, used when setting the parameter.name
- the name of the parameter, shown to the user.description
- description of the parameter, shown as help to the user.type
- type of the parameter, string for example.value
- the default value of the parameter.public Parameter(String id, String name, String description, Parameter.ParameterType type, String value, boolean hidden)
id
- the id of the parameter, used when setting the parameter.name
- the name of the parameter, shown to the user.description
- description of the parameter, shown as help to the user.type
- type of the parameter, string for example.value
- the default value of the parameter.hidden
- if true don't show the parameter to the user.public Parameter(String id, String name, String description, Parameter.ParameterType type, String value, boolean hidden, boolean allowEmpty)
id
- the id of the parameter, used when setting the parameter.name
- the name of the parameter, shown to the user.description
- description of the parameter, shown as help to the user.type
- type of the parameter, string for example.value
- the default value of the parameter.hidden
- if true don't show the parameter to the user.allowEmpty
- if true the parameter can be empty.public Parameter(String id, String name, String description, String value, String... options)
id
- the id of the parameter, used when setting the parameter.name
- the name of the parameter, shown to the user.description
- description of the parameter, shown as help to the user.value
- the default value of the parameter.options
- possible values to select from.public Parameter(String id, String name, String description, String value, boolean hidden, String... options)
id
- the id of the parameter, used when setting the parameter.name
- the name of the parameter, shown to the user.description
- description of the parameter, shown as help to the user.value
- the default value of the parameter.hidden
- if true don't show the parameter to the user.options
- possible values to select from.public Parameter(String id, String name, String description, String value, boolean hidden, boolean allowEmpty, String... options)
id
- the id of the parameter, used when setting the parameter.name
- the name of the parameter, shown to the user.description
- description of the parameter, shown as help to the user.value
- the default value of the parameter.hidden
- if true don't show the parameter to the user.allowEmpty
- if true the parameter can be empty.options
- possible values to select from.public String getID()
public void setID(String id)
id
- of the parameter.public String getName()
public void setName(String name)
name
- the new name of the parameter.public String getDescription()
public void setDescription(String description)
description
- the new description of the parameter.public Parameter.ParameterType getType()
public void setType(Parameter.ParameterType type)
type
- the new type of the parameter.public String getValue()
public void setValue(String value)
value
- the new value of the parameter.public boolean isHidden()
public void setHidden(boolean hidden)
hidden
- true if the parameter should not be shown to the user.public boolean isAllowEmpty()
public void setAllowEmpty(boolean allowEmpty)
allowNull
- true if the parameter should not be shown to the user.public String[] getOptions()
public void setOptions(String... options)
Copyright © 2017. All rights reserved.