Package ghidra.framework.options

Class AbstractOptions

  • All Implemented Interfaces:
    Options
    Direct Known Subclasses:
    ToolOptions
    public abstract class AbstractOptions
extends java.lang.Object
implements Options

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractOptions​(java.lang.String name)  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean contains​(java.lang.String optionName)
      Return true if a option exists with the given name.
      void createAlias​(java.lang.String aliasName, Options options, java.lang.String optionsName)
      Create an alias in this options for an existing option in some other options object.
      protected abstract Option createRegisteredOption​(java.lang.String optionName, OptionType type, java.lang.String description, HelpLocation help, java.lang.Object defaultValue, java.beans.PropertyEditor editor)  
      protected abstract Option createUnregisteredOption​(java.lang.String optionName, OptionType type, java.lang.Object defaultValue)  
      void dispose()  
      static java.beans.PropertyEditor findPropertyEditor​(java.lang.Class<?> originalValueClass)  
      boolean getBoolean​(java.lang.String optionName, boolean defaultValue)
      Get the boolean value for the given option name.
      byte[] getByteArray​(java.lang.String optionName, byte[] defaultValue)
      Get the byte array for the given option name.
      HelpLocation getCategoryHelpLocation​(java.lang.String categoryPath)  
      java.util.List<Options> getChildOptions()
      Returns a list of Options objects that are nested one level down from this Options object.
      java.awt.Color getColor​(java.lang.String optionName, java.awt.Color defaultValue)
      Get the Color for the given option name.
      CustomOption getCustomOption​(java.lang.String optionName, CustomOption defaultValue)
      Get the custom option value for the given option name.
      java.util.Date getDate​(java.lang.String optionName, java.util.Date defaultValue)
      Get the Date for the given option name.
      java.lang.Object getDefaultValue​(java.lang.String optionName)
      Returns the default value for the given option.
      java.lang.String getDefaultValueAsString​(java.lang.String optionName)
      Returns the default value as a string for the given option.
      java.lang.String getDescription​(java.lang.String optionName)
      Get the description for the given option name.
      double getDouble​(java.lang.String optionName, double defaultValue)
      Get the double value for the given option name.
      <T extends java.lang.Enum<T>>
      T      		 getEnum​(java.lang.String optionName, T defaultValue)
      Get the Enum value for the given option name.
      java.io.File getFile​(java.lang.String optionName, java.io.File defaultValue)
      Get the File for the given option name.
      float getFloat​(java.lang.String optionName, float defaultValue)
      Get the float value for the given option name.
      java.awt.Font getFont​(java.lang.String optionName, java.awt.Font defaultValue)
      Get the Font for the given option name.
      HelpLocation getHelpLocation​(java.lang.String optionName)
      Get the location for where help can be found for the option with the given name.
      java.lang.String getID​(java.lang.String optionName)
      Returns a unique id for option in this options with the given name.
      int getInt​(java.lang.String optionName, int defaultValue)
      Get the int value for the given option name.
      javax.swing.KeyStroke getKeyStroke​(java.lang.String optionName, javax.swing.KeyStroke defaultValue)
      Get the KeyStrokg for the given action name.
      java.util.List<java.lang.String> getLeafOptionNames()
      Returns a list of option names that immediately fall under this options.
      long getLong​(java.lang.String optionName, long defaultValue)
      Get the long value for the given option name.
      java.lang.String getName()
      Get the name of this options object.
      java.lang.Object getObject​(java.lang.String optionName, java.lang.Object defaultValue)
      Get the object value; called when the options dialog is being populated.
      Option getOption​(java.lang.String optionName, OptionType type, java.lang.Object defaultValue)  
      java.util.List<java.lang.String> getOptionNames()
      Get the list of option names.
      Options getOptions​(java.lang.String path)
      Returns a Options object that is a sub-options of this options.
      OptionsEditor getOptionsEditor()
      Get the editor that will handle editing all the values in this options or sub group of options.
      OptionsEditor getOptionsEditor​(java.lang.String categoryPath)  
      HelpLocation getOptionsHelpLocation()
      Returns the HelpLocation for this entire Options object.
      java.beans.PropertyEditor getPropertyEditor​(java.lang.String optionName)
      Get the property editor for the option with the given name.
      java.beans.PropertyEditor getRegisteredPropertyEditor​(java.lang.String optionName)
      Get the property editor that was registered for the specific option with the given name.
      java.lang.String getString​(java.lang.String optionName, java.lang.String defaultValue)
      Get the string value for the given option name.
      OptionType getType​(java.lang.String optionName)
      Returns the OptionType of the given option.
      java.lang.String getValueAsString​(java.lang.String optionName)
      Returns the value as a string for the given option.
      boolean isAlias​(java.lang.String aliasName)
      Returns
      boolean isDefaultValue​(java.lang.String optionName)
      Returns true if the option with the given name's current value is the default value.
      boolean isRegistered​(java.lang.String optionName)
      Returns true if the specified option has been registered.
      protected abstract boolean notifyOptionChanged​(java.lang.String optionName, java.lang.Object oldValue, java.lang.Object newValue)  
      void putObject​(java.lang.String optionName, java.lang.Object newValue)
      Put the object value.
      void putObject​(java.lang.String optionName, java.lang.Object newValue, OptionType type)  
      void registerOption​(java.lang.String optionName, OptionType type, java.lang.Object defaultValue, HelpLocation help, java.lang.String description)
      Registers an option with a description, help location, and a optional default value.
      void registerOption​(java.lang.String optionName, OptionType type, java.lang.Object defaultValue, HelpLocation help, java.lang.String description, java.beans.PropertyEditor editor)
      Registers an option with a description, help location, and a optional default value.
      void registerOption​(java.lang.String optionName, java.lang.Object defaultValue, HelpLocation help, java.lang.String description)
      Registers an option with a description, help location, and a default value without specifying the option type.
      void registerOptionsEditor​(OptionsEditor editor)
      Register the options editor that will handle the editing for all the options or a sub group of options.
      void registerOptionsEditor​(java.lang.String categoryPath, OptionsEditor editor)  
      void removeOption​(java.lang.String optionName)
      Remove the option name.
      void restoreDefaultValue​(java.lang.String optionName)
      Restores the option denoted by the given name to its default value.
      void restoreDefaultValues()
      Restores all options contained herein to their default values.
      void setBoolean​(java.lang.String optionName, boolean value)
      Sets the boolean value for the option.
      void setByteArray​(java.lang.String optionName, byte[] value)
      Sets the byte[] value for the given option name.
      void setCategoryHelpLocation​(java.lang.String categoryPath, HelpLocation helpLocation)  
      void setColor​(java.lang.String optionName, java.awt.Color value)
      Sets the Color value for the option
      void setCustomOption​(java.lang.String optionName, CustomOption value)
      Sets the Custom option value for the option.
      void setDate​(java.lang.String optionName, java.util.Date value)
      Sets the Date value for the option.
      void setDouble​(java.lang.String optionName, double value)
      Sets the double value for the option.
      <T extends java.lang.Enum<T>>
      void      		 setEnum​(java.lang.String optionName, T value)
      Set the Enum value for the option.
      void setFile​(java.lang.String optionName, java.io.File value)
      Sets the File value for the option.
      void setFloat​(java.lang.String optionName, float value)
      Sets the float value for the option.
      void setFont​(java.lang.String optionName, java.awt.Font value)
      Sets the Font value for the option
      void setInt​(java.lang.String optionName, int value)
      Sets the int value for the option.
      void setKeyStroke​(java.lang.String optionName, javax.swing.KeyStroke value)
      Sets the KeyStroke value for the option
      void setLong​(java.lang.String optionName, long value)
      Sets the long value for the option.
      void setName​(java.lang.String newName)
      Sets the name for this Options object.
      void setOptionsHelpLocation​(HelpLocation helpLocation)
      Set the location for where help can be found for this entire options object.
      void setString​(java.lang.String optionName, java.lang.String value)
      Set the String value for the option.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SUPPORTED_CLASSES

        public static final java.util.Set<java.lang.Class<?>> SUPPORTED_CLASSES

      • name

        protected java.lang.String name

      • valueMap

        protected java.util.Map<java.lang.String,​Option> valueMap

      • optionsEditorMap

        protected java.util.Map<java.lang.String,​OptionsEditor> optionsEditorMap

      • categoryHelpMap

        protected java.util.Map<java.lang.String,​HelpLocation> categoryHelpMap

    • Constructor Detail

      • AbstractOptions

        protected AbstractOptions​(java.lang.String name)

    • Method Detail

      • createRegisteredOption

        protected abstract Option createRegisteredOption​(java.lang.String optionName,
                                                 OptionType type,
                                                 java.lang.String description,
                                                 HelpLocation help,
                                                 java.lang.Object defaultValue,
                                                 java.beans.PropertyEditor editor)

      • createUnregisteredOption

        protected abstract Option createUnregisteredOption​(java.lang.String optionName,
                                                   OptionType type,
                                                   java.lang.Object defaultValue)

      • notifyOptionChanged

        protected abstract boolean notifyOptionChanged​(java.lang.String optionName,
                                               java.lang.Object oldValue,
                                               java.lang.Object newValue)

      • registerOptionsEditor

        public void registerOptionsEditor​(java.lang.String categoryPath,
                                  OptionsEditor editor)

      • getOptionsEditor

        public OptionsEditor getOptionsEditor​(java.lang.String categoryPath)

      • dispose

        public void dispose()

      • getName

        public java.lang.String getName()
        Description copied from interface: Options
        Get the name of this options object.
        Specified by:
        getName in interface Options
        Returns:
        String

      • setName

        public void setName​(java.lang.String newName)
        Sets the name for this Options object. Used when updating old options names to new names.
        Parameters:
        newName - the new name for this options object.

      • registerOption

        public void registerOption​(java.lang.String optionName,
                           java.lang.Object defaultValue,
                           HelpLocation help,
                           java.lang.String description)
        Description copied from interface: Options
        Registers an option with a description, help location, and a default value without specifying the option type. This form requires that the default value not be null so that the option type can be inferred from the default value.
        Specified by:
        registerOption in interface Options
        Parameters:
        optionName - the name of the option being registered.
        defaultValue - the defaultValue for the option. The default value must not be null so that the OptionType can be determined. If the default value should be null, use Options.registerOption(String, OptionType, Object, HelpLocation, String)
        help - the HelpLocation for this option.
        description - a description of the option.

      • registerOption

        public void registerOption​(java.lang.String optionName,
                           OptionType type,
                           java.lang.Object defaultValue,
                           HelpLocation help,
                           java.lang.String description)
        Description copied from interface: Options
        Registers an option with a description, help location, and a optional default value. With an optional default value, an OptionType must be passed as it is otherwise derived from the default value.
        Specified by:
        registerOption in interface Options
        Parameters:
        optionName - the name of the option being registered.
        type - the OptionType for this options.
        defaultValue - the defaultValue for the option. In this version of the method, the default value may be null.
        help - the HelpLocation for this option.
        description - a description of the option.

      • registerOption

        public void registerOption​(java.lang.String optionName,
                           OptionType type,
                           java.lang.Object defaultValue,
                           HelpLocation help,
                           java.lang.String description,
                           java.beans.PropertyEditor editor)
        Description copied from interface: Options
        Registers an option with a description, help location, and a optional default value. With an optional default value, an OptionType must be passed as it is otherwise derived from the default value.
        Specified by:
        registerOption in interface Options
        Parameters:
        optionName - the name of the option being registered.
        type - the OptionType for this options.
        defaultValue - the defaultValue for the option. In this version of the method, the default value may be null.
        help - the HelpLocation for this option.
        description - a description of the option.
        editor - an optional custom editor for this property. Note if the option is a custom option, then the property editor can't be null;

      • removeOption

        public void removeOption​(java.lang.String optionName)
        Description copied from interface: Options
        Remove the option name.
        Specified by:
        removeOption in interface Options
        Parameters:
        optionName - name of option to remove

      • getOptionNames

        public java.util.List<java.lang.String> getOptionNames()
        Description copied from interface: Options
        Get the list of option names. This method will return the names (paths) of all options contained in this options object or below. For example, if the options has ("aaa", "bbb", "ccc.ddd"), all three will be returned. the Options.getLeafOptionNames() method will return only the "aaa" and "bbb" names.
        Specified by:
        getOptionNames in interface Options
        Returns:
        the list of all option names(paths) under this options.

      • getObject

        public java.lang.Object getObject​(java.lang.String optionName,
                                  java.lang.Object defaultValue)
        Description copied from interface: Options
        Get the object value; called when the options dialog is being populated.
        Specified by:
        getObject in interface Options
        Parameters:
        optionName - option name
        defaultValue - default value
        Returns:
        object with the given option name; if no option was found, return default value (this value is not stored in the option maps)

      • getOption

        public Option getOption​(java.lang.String optionName,
                        OptionType type,
                        java.lang.Object defaultValue)

      • putObject

        public void putObject​(java.lang.String optionName,
                      java.lang.Object newValue)
        Description copied from interface: Options
        Put the object value. If the option exists, the type must match the type of the existing object.
        Specified by:
        putObject in interface Options

      • putObject

        public void putObject​(java.lang.String optionName,
                      java.lang.Object newValue,
                      OptionType type)

      • getType

        public OptionType getType​(java.lang.String optionName)
        Description copied from interface: Options
        Returns the OptionType of the given option.
        Specified by:
        getType in interface Options
        Parameters:
        optionName - the name of the option for which to get the type.
        Returns:
        the OptionType of option with the given name.

      • getBoolean

        public boolean getBoolean​(java.lang.String optionName,
                          boolean defaultValue)
        Description copied from interface: Options
        Get the boolean value for the given option name.
        Specified by:
        getBoolean in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name.
        Returns:
        boolean option value

      • getByteArray

        public byte[] getByteArray​(java.lang.String optionName,
                           byte[] defaultValue)
        Description copied from interface: Options
        Get the byte array for the given option name.
        Specified by:
        getByteArray in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        byte[] byte array value

      • getInt

        public int getInt​(java.lang.String optionName,
                  int defaultValue)
        Description copied from interface: Options
        Get the int value for the given option name.
        Specified by:
        getInt in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        int option value

      • getDouble

        public double getDouble​(java.lang.String optionName,
                        double defaultValue)
        Description copied from interface: Options
        Get the double value for the given option name.
        Specified by:
        getDouble in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        double value for the option

      • getFloat

        public float getFloat​(java.lang.String optionName,
                      float defaultValue)
        Description copied from interface: Options
        Get the float value for the given option name.
        Specified by:
        getFloat in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        float value for the option

      • getLong

        public long getLong​(java.lang.String optionName,
                    long defaultValue)
        Description copied from interface: Options
        Get the long value for the given option name.
        Specified by:
        getLong in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        long value for the option

      • getCustomOption

        public CustomOption getCustomOption​(java.lang.String optionName,
                                    CustomOption defaultValue)
        Description copied from interface: Options
        Get the custom option value for the given option name.
        Specified by:
        getCustomOption in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        WrappedOption value for the option

      • getColor

        public java.awt.Color getColor​(java.lang.String optionName,
                               java.awt.Color defaultValue)
        Description copied from interface: Options
        Get the Color for the given option name.
        Specified by:
        getColor in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        Color option

      • getFile

        public java.io.File getFile​(java.lang.String optionName,
                            java.io.File defaultValue)
        Description copied from interface: Options
        Get the File for the given option name.
        Specified by:
        getFile in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        File option

      • getFont

        public java.awt.Font getFont​(java.lang.String optionName,
                             java.awt.Font defaultValue)
        Description copied from interface: Options
        Get the Font for the given option name.
        Specified by:
        getFont in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        Font option

      • getDate

        public java.util.Date getDate​(java.lang.String optionName,
                              java.util.Date defaultValue)
        Description copied from interface: Options
        Get the Date for the given option name.
        Specified by:
        getDate in interface Options
        Returns:
        the Date for the option

      • getKeyStroke

        public javax.swing.KeyStroke getKeyStroke​(java.lang.String optionName,
                                          javax.swing.KeyStroke defaultValue)
        Description copied from interface: Options
        Get the KeyStrokg for the given action name.
        Specified by:
        getKeyStroke in interface Options
        Parameters:
        optionName - the option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        KeyStroke option

      • getString

        public java.lang.String getString​(java.lang.String optionName,
                                  java.lang.String defaultValue)
        Description copied from interface: Options
        Get the string value for the given option name.
        Specified by:
        getString in interface Options
        Parameters:
        optionName - option name
        defaultValue - value that is stored and returned if there is no option with the given name
        Returns:
        String value for the option

      • getEnum

        public <T extends java.lang.Enum<T>> T getEnum​(java.lang.String optionName,
                                               T defaultValue)
        Description copied from interface: Options
        Get the Enum value for the given option name.
        Specified by:
        getEnum in interface Options
        Parameters:
        optionName - option name
        defaultValue - default value that is stored and returned if there is no option with the given name
        Returns:
        Enum value for the option

      • setLong

        public void setLong​(java.lang.String optionName,
                    long value)
        Description copied from interface: Options
        Sets the long value for the option.
        Specified by:
        setLong in interface Options
        Parameters:
        optionName - name of the option
        value - value of the option

      • setBoolean

        public void setBoolean​(java.lang.String optionName,
                       boolean value)
        Description copied from interface: Options
        Sets the boolean value for the option.
        Specified by:
        setBoolean in interface Options
        Parameters:
        optionName - name of the option
        value - value of the option

      • setInt

        public void setInt​(java.lang.String optionName,
                   int value)
        Description copied from interface: Options
        Sets the int value for the option.
        Specified by:
        setInt in interface Options
        Parameters:
        optionName - name of the option
        value - value of the option

      • setDouble

        public void setDouble​(java.lang.String optionName,
                      double value)
        Description copied from interface: Options
        Sets the double value for the option.
        Specified by:
        setDouble in interface Options
        Parameters:
        optionName - name of the option
        value - value of the option

      • setFloat

        public void setFloat​(java.lang.String optionName,
                     float value)
        Description copied from interface: Options
        Sets the float value for the option.
        Specified by:
        setFloat in interface Options
        Parameters:
        optionName - name of the option
        value - value of the option

      • setCustomOption

        public void setCustomOption​(java.lang.String optionName,
                            CustomOption value)
        Description copied from interface: Options
        Sets the Custom option value for the option.
        Specified by:
        setCustomOption in interface Options
        Parameters:
        optionName - name of the option

      • setByteArray

        public void setByteArray​(java.lang.String optionName,
                         byte[] value)
        Description copied from interface: Options
        Sets the byte[] value for the given option name.
        Specified by:
        setByteArray in interface Options
        Parameters:
        optionName - the name of the option on which to save bytes.

      • setFile

        public void setFile​(java.lang.String optionName,
                    java.io.File value)
        Description copied from interface: Options
        Sets the File value for the option.
        Specified by:
        setFile in interface Options
        Parameters:
        optionName - name of the option

      • setColor

        public void setColor​(java.lang.String optionName,
                     java.awt.Color value)
        Description copied from interface: Options
        Sets the Color value for the option
        Specified by:
        setColor in interface Options
        Parameters:
        optionName - name of the option
        value - Color to set

      • setFont

        public void setFont​(java.lang.String optionName,
                    java.awt.Font value)
        Description copied from interface: Options
        Sets the Font value for the option
        Specified by:
        setFont in interface Options
        Parameters:
        optionName - name of the option
        value - Font to set

      • setDate

        public void setDate​(java.lang.String optionName,
                    java.util.Date value)
        Description copied from interface: Options
        Sets the Date value for the option.
        Specified by:
        setDate in interface Options
        Parameters:
        optionName - name of the option

      • setKeyStroke

        public void setKeyStroke​(java.lang.String optionName,
                         javax.swing.KeyStroke value)
        Description copied from interface: Options
        Sets the KeyStroke value for the option
        Specified by:
        setKeyStroke in interface Options
        Parameters:
        optionName - name of the option
        value - KeyStroke to set

      • setString

        public void setString​(java.lang.String optionName,
                      java.lang.String value)
        Description copied from interface: Options
        Set the String value for the option.
        Specified by:
        setString in interface Options
        Parameters:
        optionName - name of the option
        value - value of the option

      • setEnum

        public <T extends java.lang.Enum<T>> void setEnum​(java.lang.String optionName,
                                                  T value)
        Description copied from interface: Options
        Set the Enum value for the option.
        Specified by:
        setEnum in interface Options
        Parameters:
        optionName - name of the option
        value - Enum value of the option

      • getDefaultValue

        public java.lang.Object getDefaultValue​(java.lang.String optionName)
        Description copied from interface: Options
        Returns the default value for the given option.
        Specified by:
        getDefaultValue in interface Options
        Parameters:
        optionName - the name of the option for which to retrieve the default value.
        Returns:
        the default value for the given option.

      • getPropertyEditor

        public java.beans.PropertyEditor getPropertyEditor​(java.lang.String optionName)
        Description copied from interface: Options
        Get the property editor for the option with the given name. Note: This method must be called from the swing thread.
        Specified by:
        getPropertyEditor in interface Options
        Returns:
        either the PropertyEditor that was registered for this option or a default editor for the property type if one can be found; otherwise null.

      • getRegisteredPropertyEditor

        public java.beans.PropertyEditor getRegisteredPropertyEditor​(java.lang.String optionName)
        Description copied from interface: Options
        Get the property editor that was registered for the specific option with the given name. Unlike the getPropertyEditor() method, this method does not have to be called from the swing thread
        Specified by:
        getRegisteredPropertyEditor in interface Options
        Returns:
        the PropertyEditor that was registered for this option.

      • contains

        public boolean contains​(java.lang.String optionName)
        Description copied from interface: Options
        Return true if a option exists with the given name.
        Specified by:
        contains in interface Options
        Parameters:
        optionName - option name

      • getDescription

        public java.lang.String getDescription​(java.lang.String optionName)
        Description copied from interface: Options
        Get the description for the given option name.
        Specified by:
        getDescription in interface Options
        Parameters:
        optionName - name of the option
        Returns:
        null if the description or option name does not exist

      • getHelpLocation

        public HelpLocation getHelpLocation​(java.lang.String optionName)
        Description copied from interface: Options
        Get the location for where help can be found for the option with the given name.
        Specified by:
        getHelpLocation in interface Options
        Parameters:
        optionName - name of the option
        Returns:
        null if the help location was not set on the option

      • isRegistered

        public boolean isRegistered​(java.lang.String optionName)
        Description copied from interface: Options
        Returns true if the specified option has been registered. Only registered names are saved.
        Specified by:
        isRegistered in interface Options

      • isDefaultValue

        public boolean isDefaultValue​(java.lang.String optionName)
        Description copied from interface: Options
        Returns true if the option with the given name's current value is the default value.
        Specified by:
        isDefaultValue in interface Options
        Parameters:
        optionName - the name of the option.
        Returns:
        true if the options has its current value equal to its default value.

      • restoreDefaultValue

        public void restoreDefaultValue​(java.lang.String optionName)
        Description copied from interface: Options
        Restores the option denoted by the given name to its default value.
        Specified by:
        restoreDefaultValue in interface Options
        Parameters:
        optionName - The name of the option to restore
        See Also:
        Options.restoreDefaultValues()

      • getChildOptions

        public java.util.List<Options> getChildOptions()
        Description copied from interface: Options
        Returns a list of Options objects that are nested one level down from this Options object.
        Specified by:
        getChildOptions in interface Options
        Returns:
        a list of Options objects that are nested one level down from this Options object.

      • getOptions

        public Options getOptions​(java.lang.String path)
        Description copied from interface: Options
        Returns a Options object that is a sub-options of this options.
        Specified by:
        getOptions in interface Options
        Parameters:
        path - the path for the sub-options object.
        Returns:
        a Options object that is a sub-options of this options.

      • setOptionsHelpLocation

        public void setOptionsHelpLocation​(HelpLocation helpLocation)
        Description copied from interface: Options
        Set the location for where help can be found for this entire options object.
        Specified by:
        setOptionsHelpLocation in interface Options
        Parameters:
        helpLocation - location for help on the option

      • getOptionsHelpLocation

        public HelpLocation getOptionsHelpLocation()
        Description copied from interface: Options
        Returns the HelpLocation for this entire Options object.
        Specified by:
        getOptionsHelpLocation in interface Options
        Returns:
        the HelpLocation for this entire Options object.

      • registerOptionsEditor

        public void registerOptionsEditor​(OptionsEditor editor)
        Description copied from interface: Options
        Register the options editor that will handle the editing for all the options or a sub group of options.
        Specified by:
        registerOptionsEditor in interface Options
        Parameters:
        editor - the custom editor panel to be used to edit the options or sub group of options.

      • getOptionsEditor

        public OptionsEditor getOptionsEditor()
        Description copied from interface: Options
        Get the editor that will handle editing all the values in this options or sub group of options.
        Specified by:
        getOptionsEditor in interface Options
        Returns:
        null if no options editor was registered

      • createAlias

        public void createAlias​(java.lang.String aliasName,
                        Options options,
                        java.lang.String optionsName)
        Description copied from interface: Options
        Create an alias in this options for an existing option in some other options object.
        Specified by:
        createAlias in interface Options
        Parameters:
        aliasName - the name within this options object that will acutally refer to some other options object.
        options - the options object that has the actual option.
        optionsName - the name within the given options object of the actual option.

      • isAlias

        public boolean isAlias​(java.lang.String aliasName)
        Description copied from interface: Options
        Returns
        Specified by:
        isAlias in interface Options
        Parameters:
        aliasName - the name of the alias.
        Returns:
        a Options object that is a sub-options of this options.

      • setCategoryHelpLocation

        public void setCategoryHelpLocation​(java.lang.String categoryPath,
                                    HelpLocation helpLocation)

      • getCategoryHelpLocation

        public HelpLocation getCategoryHelpLocation​(java.lang.String categoryPath)

      • getID

        public java.lang.String getID​(java.lang.String optionName)
        Description copied from interface: Options
        Returns a unique id for option in this options with the given name. This will be the full path name to the root options object.
        Specified by:
        getID in interface Options
        Parameters:
        optionName - the name of the option for which to get an ID;
        Returns:
        the unique ID for the given option.

      • getValueAsString

        public java.lang.String getValueAsString​(java.lang.String optionName)
        Description copied from interface: Options
        Returns the value as a string for the given option.
        Specified by:
        getValueAsString in interface Options
        Returns:
        the value as a string for the given option.

      • getDefaultValueAsString

        public java.lang.String getDefaultValueAsString​(java.lang.String optionName)
        Description copied from interface: Options
        Returns the default value as a string for the given option.
        Specified by:
        getDefaultValueAsString in interface Options
        Returns:
        the default value as a string for the given option.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getLeafOptionNames

        public java.util.List<java.lang.String> getLeafOptionNames()
        Description copied from interface: Options
        Returns a list of option names that immediately fall under this options. For example, if this options object had the following options named ("a", "b", "c.d"), only "a" and "b" would be returned. The "c.d" leaf option name could be returned by getOptions("c").getLeafOptionNames()
        Specified by:
        getLeafOptionNames in interface Options
        Returns:
        the list of the names of the options that are immediate children of this options object.

      • findPropertyEditor

        public static java.beans.PropertyEditor findPropertyEditor​(java.lang.Class<?> originalValueClass)