Package gnu.text

Class Options

java.lang.Object
gnu.text.Options
public class Options extends Object
Mananges a table of named options, Can inherit from another table of "default" options.

  • Field Details

  • Constructor Details

    • Options

      public Options()

    • Options

      public Options(Options previous)

  • Method Details

    • add

      public Options.OptionInfo add(String key, int kind, String documentation)
      Create a new option and enters it in this table. A duplicate option throws a RuntimeException.
      Parameters:
      key - the options name (key).
      kind - type and other flag bits of the option.
      documentation - a String describing what the option does.

    • add

      public Options.OptionInfo add(String key, int kind, Object defaultValue, String documentation)

    • booleanValue

      public static Boolean booleanValue(String argument)

    • set

      public void set(String key, Object value)
      Set the value of a named option.

    • set

      public Object set(String key, Object value, SourceMessages messages)
      Set the value of a named option. Return old value, in form suitable for reset.

    • reset

      public void reset(String key, Object oldValue)
      Reset the value of a named option.

    • set

      public String set(String key, String argument)
      Set the value of the key to the argument, appropriate parsed. return null on success or a String error message. If the option key is invalid, return UNKNOWN.

    • getInfo

      public Options.OptionInfo getInfo(String key)

    • get

      public Object get(String key, Object defaultValue)
      Get the value for the option. Throws an except if there is no option by that name, Returns defaultValue if there is such an option, but it hasn't been set.

    • get

      public Object get(Options.OptionInfo key, Object defaultValue)

    • get

      public Object get(Options.OptionInfo key)

    • getLocal

      public Object getLocal(String key)
      Get current option value. Only look in local table, not in inherited Options. Return null if there is no binding (even when get would throw an exception on an unknown option).

    • getBoolean

      public boolean getBoolean(String key)

    • getBoolean

      public boolean getBoolean(String key, boolean defaultValue)

    • getBoolean

      public boolean getBoolean(Options.OptionInfo key, boolean defaultValue)

    • getBoolean

      public boolean getBoolean(Options.OptionInfo key)

    • getInt

      public int getInt(Options.OptionInfo key, int defaultValue)

    • pushOptionValues

      public void pushOptionValues(Vector options)
      Set a list of options, remember the old value.
      Parameters:
      options - is vector of triples, echo of which is consisting of: a String option key; an entry whose value is ignored and is used to store the old value; and a new value for the option.

    • popOptionValues

      public void popOptionValues(Vector options)
      Restore a list of options, as set by pushOptionValues

    • keys

      public ArrayList<String> keys()
      Return the list of option keys.

    • getDoc

      public String getDoc(String key)