Interface IDialogSettings

  • All Known Implementing Classes:
    DialogSettings

    public interface IDialogSettings
    An interface to a storage mechanism for making dialog settings persistent. The store manages a collection of key/value pairs. The keys must be strings and the values can be either, strings or array of strings. Convenience API to convert primitive types to strings is provided.
    See Also:
    DialogSettings
    • Method Detail

      • addSection

        void addSection​(IDialogSettings section)
        Add a section in the receiver.
        Parameters:
        section - the section to be added
      • get

        String get​(String key)
        Returns the value of the given key in this dialog settings.
        Parameters:
        key - the key
        Returns:
        the value, or null if none
      • getArray

        String[] getArray​(String key)
        Returns the value, an array of strings, of the given key in this dialog settings.
        Parameters:
        key - the key
        Returns:
        the array of string, or null if none
      • getBoolean

        boolean getBoolean​(String key)
        Convenience API. Convert the value of the given key in this dialog settings to a boolean and return it.
        Parameters:
        key - the key
        Returns:
        the boolean value, or false if none
      • getDouble

        double getDouble​(String key)
                  throws NumberFormatException
        Convenience API. Convert the value of the given key in this dialog settings to a double and return it.
        Parameters:
        key - the key
        Returns:
        the value coverted to double, or throws NumberFormatException if none
        Throws:
        NumberFormatException - if the string value does not contain a parsable number.
        See Also:
        Double.valueOf(java.lang.String)
      • getFloat

        float getFloat​(String key)
                throws NumberFormatException
        Convenience API. Convert the value of the given key in this dialog settings to a float and return it.
        Parameters:
        key - the key
        Returns:
        the value coverted to float, or throws NumberFormatException if none
        Throws:
        NumberFormatException - if the string value does not contain a parsable number.
        See Also:
        Float.valueOf(java.lang.String)
      • getLong

        long getLong​(String key)
              throws NumberFormatException
        Convenience API. Convert the value of the given key in this dialog settings to a long and return it.
        Parameters:
        key - the key
        Returns:
        the value coverted to long, or throws NumberFormatException if none
        Throws:
        NumberFormatException - if the string value does not contain a parsable number.
        See Also:
        Long.valueOf(java.lang.String)
      • getName

        String getName()
        Returns the IDialogSettings name.
        Returns:
        the name
      • getSections

        IDialogSettings[] getSections()
        Returns all the sections in this dialog settings.
        Returns:
        the section, or null if none
      • load

        void load​(Reader reader)
           throws IOException
        Load a dialog settings from a stream and fill the receiver with its content.
        Parameters:
        reader - a Reader specifying the stream where the settings are read from.
        Throws:
        IOException
      • load

        void load​(String fileName)
           throws IOException
        Load a dialog settings from a file and fill the receiver with its content.
        Parameters:
        fileName - the name of the file the settings are read from.
        Throws:
        IOException
      • put

        void put​(String key,
                 String[] value)
        Adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • put

        void put​(String key,
                 double value)
        Convenience API. Converts the double value to a string and adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • put

        void put​(String key,
                 float value)
        Convenience API. Converts the float value to a string and adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • put

        void put​(String key,
                 int value)
        Convenience API. Converts the int value to a string and adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • put

        void put​(String key,
                 long value)
        Convenience API. Converts the long value to a string and adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • put

        void put​(String key,
                 String value)
        Adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • put

        void put​(String key,
                 boolean value)
        Convenience API. Converts the boolean value to a string and adds the pair key/value to this dialog settings.
        Parameters:
        key - the key.
        value - the value to be associated with the key
      • save

        void save​(Writer writer)
           throws IOException
        Save a dialog settings to a stream
        Parameters:
        writer - a Writer specifying the stream the settings are written in.
        Throws:
        IOException
      • save

        void save​(String fileName)
           throws IOException
        Save a dialog settings to a file.
        Parameters:
        fileName - the name of the file the settings are written in.
        Throws:
        IOException