Class Setting

java.lang.Object
net.sourceforge.jnlp.config.Setting
public class Setting extends Object
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.

  • Field Details

    • name

      private final String name

    • description

      private final String description

    • validator

      private final ValueValidator validator

    • source

      private final String source

    • defaultValue

      private final String defaultValue

    • value

      private String value

    • locked

      private boolean locked

  • Constructor Details

    • Setting

      private Setting(String name, String description, boolean locked, ValueValidator validator, String defaultValue, String value, String source)
      Creates a new Settings object
      Parameters:
      name - the name of this setting
      description - a human readable description of this setting
      locked - whether this setting is currently locked
      validator - the ValueValidator that can be used to validate the value
      defaultValue - the default value of this setting. If this is not a recognized setting, use null.
      value - the initial value of this setting
      source - the origin of the value (a file, or perhaps "<internal>")

  • Method Details

    • createDefault

      public static Setting createDefault(String key, String value, ValueValidator validator)

    • createUnknown

      public static Setting createUnknown(String key, String value)

    • createFromPropertyFile

      public static Setting createFromPropertyFile(String key, String value, boolean locked, URL propertyFile)

    • copy

      public Setting copy()
      Creates a copy of this setting

    • copyValuesFrom

      Setting copyValuesFrom(Setting src)
      Creates a copy of this setting and copies the following attributes from src: - value - locked - source

    • getValidator

      public ValueValidator getValidator()
      Returns:
      the ValueValidator that can be used to check if the current value is valid

    • getDefaultValue

      public String getDefaultValue()
      Returns:
      the default value for this setting. May be null if this is not one of the supported settings

    • getDescription

      public String getDescription()
      Returns:
      a human readable description of this setting

    • getName

      public String getName()
      Returns:
      the name (like foo.bar.baz) of this setting

    • getSource

      public String 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

      public String getValue()
      Returns:
      the current value of this setting

    • isLocked

      public boolean isLocked()
      Returns:
      true if this setting is locked

    • setValue

      public void setValue(String value)
      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

      public String toString()
      Overrides:
      toString in class Object