|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.PluginParameter<T>
public class PluginParameter<T>
Contains information about a single parameter that the plugin needs for a request.
RequestInformation
,
PluginRequest
Field Summary | |
---|---|
private T |
defaultValue
A default value that overrides the default set by the parameter type. |
private String |
description
A longer help text explaining what the particular parameter is needed for. |
boolean |
hidden
If the parameter should be hidden from user input or not. |
private String |
label
A short label used by the client application as in the GUI. |
private String |
name
The name of the parameter that the plugin use to identify the value with. |
private ParameterType<T> |
type
Information of the parameter type. |
Constructor Summary | |
---|---|
PluginParameter(String name,
String label,
String description,
ParameterType<T> type)
Constructor that sets all members except the default value. |
|
PluginParameter(String name,
String label,
String description,
T defaultValue,
ParameterType<T> type)
Constructor that sets all members. |
Method Summary | |
---|---|
T |
getDefaultValue()
Get the default value for this parameter or null if no default has been specified |
String |
getDescription()
Get a description of the parameter. |
String |
getLabel()
Get the label of the parameter. |
String |
getName()
Get the parameter name. |
ParameterType<T> |
getParameterType()
Get the parameter type, which tells the client application the data type and allowed values for the parameter. |
boolean |
isHidden()
Check if the parameter is a hidden parameter or not. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public final boolean hidden
private final String name
private final String label
private final String description
private final T defaultValue
private final ParameterType<T> type
Constructor Detail |
---|
public PluginParameter(String name, String label, String description, ParameterType<T> type)
name
- The name of the parameter, null is allowed for section headerslabel
- Label that can be used in the GUI for the parameter, or null
to create a hidden parameterdescription
- A help text explaining what the parameter is used fortype
- The parameter type, or null to create a section headerpublic PluginParameter(String name, String label, String description, T defaultValue, ParameterType<T> type)
name
- The name of the parameter, null is allowed for section headerslabel
- Label that can be used in the GUI for the parameter, or null
to create a hidden parameterdescription
- A help text explaining what the parameter is used fordefaultValue
- The default value of the parameter or null to use
the default set by the parameter typetype
- The parameter type, or null to create a section headerMethod Detail |
---|
public String toString()
toString
in class Object
public boolean isHidden()
getParmeterType().getDefaultValue()
public String getName()
PluginRequest.setParameterValue(String, Object)
.
public String getLabel()
public String getDescription()
public T getDefaultValue()
public ParameterType<T> getParameterType()
ParameterType
object
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |