Package net.sourceforge.jnlp.config
Class Setting<T>
java.lang.Object
net.sourceforge.jnlp.config.Setting<T>
Represents a value for a configuration. Provides methods to get the value
as well as marking the value as locked.
Each instance of this class has an associated ValueChecker. This checker
can be used to check if the current value is valid. The default value
_must_ be valid. Null values can not originate externally so are (mostly)
considered valid.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetName()
getValue()
boolean
isLocked()
void
setLocked
(boolean locked) Marks this setting as locked or unlocked.void
Sets the source of the current value of this Setting.void
Note that setting the value is not enforced - it is the caller's responsibility to check if a value is locked or not before setting a new valuetoString()
-
Constructor Details
-
Setting
public Setting(String name, String description, boolean locked, ValueValidator validator, T defaultValue, T value, String source) Creates a new Settings object- Parameters:
name
- the name of this settingdescription
- a human readable description of this settinglocked
- whether this setting is currently lockedvalidator
- theValueValidator
that can be used to validate the valuedefaultValue
- the default value of this setting. If this is not a recognized setting, use null.value
- the initial value of this settingsource
- the origin of the value (a file, or perhaps "<internal>
")
-
Setting
Creates a new Settings object by cloning the values from another Settings object- Parameters:
other
- a Settings object to initialize settings from
-
-
Method Details
-
getValidator
- Returns:
- the
ValueValidator
that can be used to check if the current value is valid
-
getDefaultValue
- Returns:
- the default value for this setting. May be null if this is not one of the supported settings
-
getDescription
- Returns:
- a human readable description of this setting
-
getName
- Returns:
- the name (like foo.bar.baz) of this setting
-
getSource
- Returns:
- the source of the current value of this setting. May be a string like "internal" or it may be the location of the properties file
-
getValue
- Returns:
- the current value of this setting
-
isLocked
public boolean isLocked()- Returns:
- true if this setting is locked
-
setLocked
public void setLocked(boolean locked) Marks this setting as locked or unlocked. Setting the value is not enforced by this class.- Parameters:
locked
- whether to mark this setting as locked or not locked.
-
setSource
Sets the source of the current value of this Setting. Maybe a string like "internal" or the location of the properties file- Parameters:
source
- the source of the value
-
setValue
Note that setting the value is not enforced - it is the caller's responsibility to check if a value is locked or not before setting a new value- Parameters:
value
- the new value
-
toString
-