net.sf.basedb.core.ParameterInfo

public class ParameterInfo
extends Object

Get information about a plugin configuration or parameter. The information include the label, description and values of the parameter.

Method Summary

Modifier and Type	Method	Description
`String`	`getDescription()`
`String`	`getLabel()`
`List<?>`	`getValues()`
`List<?>`	`getValuesOrMask()`	Utility method for getting the values or a mask (*****) if the `isMasked()` flag is set.
`List<?>`	`getValuesOrMask(String mask)`	Utility method for getting the values or a mask if the `isMasked()` flag is set.
`Type`	`getValueType()`	Get the matching `Type` for the values stored in this parameter.
`boolean`	`isMasked()`	Should this parameter be masked in the GUI?

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

Field Details
- label
  
  private final String label
- description
  
  private final String description
- masked
  
  private final boolean masked
- values
  
  private final List<?> values
- valueType
  
  private final Type valueType
Constructor Details
- ParameterInfo
  
  ParameterInfo(DbControl dc, ParameterValueData<?> parameter)
Method Details
- getLabel
  
  public String getLabel()
- getDescription
  
  public String getDescription()
- isMasked
  
  public boolean isMasked()
  
  Should this parameter be masked in the GUI?
  
  Since:
  
  3.7
- getValueType
  
  public Type getValueType()
  
  Get the matching Type for the values stored in this parameter. Can be null since not all parameter types have a matching value type.
  
  Returns:
  
  A Type object or null
  
  Since:
  
  2.16
- getValues
  
  public List<?> getValues()
- getValuesOrMask
  
  public List<?> getValuesOrMask()
  
  Utility method for getting the values or a mask (*****) if the isMasked() flag is set.
  
  Since:
  
  3.7
- getValuesOrMask
  
  public List<?> getValuesOrMask(String mask)
  
  Utility method for getting the values or a mask if the isMasked() flag is set.
  
  Since:
  
  3.7

Class ParameterInfo