Package net.sourceforge.jnlp.config
Class Setting
java.lang.Object
net.sourceforge.jnlp.config.Setting
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.
-
Method Summary
Modifier and TypeMethodDescriptioncopy()Creates a copy of this settingstatic SettingcreateDefault(String key, String value, ValueValidator validator) static SettingcreateFromPropertyFile(String key, String value, boolean locked, URL propertyFile) static SettingcreateUnknown(String key, String value) getName()getValue()booleanisLocked()voidsetLocked(boolean locked) voidNote 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()
-
Method Details
-
createDefault
-
createUnknown
-
createFromPropertyFile
-
copy
Creates a copy of this setting -
getValidator
- Returns:
- the
ValueValidatorthat 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
-
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
-
setLocked
public void setLocked(boolean locked) -
toString
-