Package org.jfree.util
Class SortedConfigurationWriter
java.lang.Object
org.jfree.util.SortedConfigurationWriter
Writes a
Configuration
instance into a property file, where
the keys are sorted by their name. Writing sorted keys make it easier for
users to find and change properties in the file.- Author:
- Thomas Morgner
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
getDescription
(String key) Returns a description for the given key.void
save
(File file, Configuration config) Saves the given configuration into a file specified by the given file object.void
save
(OutputStream outStream, Configuration config) Writes the configuration into the given output stream.void
save
(String filename, Configuration config) Saves the given configuration into a file specified by the given filename.
-
Constructor Details
-
SortedConfigurationWriter
public SortedConfigurationWriter()The default constructor, does nothing.
-
-
Method Details
-
getDescription
Returns a description for the given key. This implementation returns null to indicate that no description should be written. Subclasses can overwrite this method to provide comments for every key. These descriptions will be included as inline comments.- Parameters:
key
- the key for which a description should be printed.- Returns:
- the description or null if no description should be printed.
-
save
Saves the given configuration into a file specified by the given filename.- Parameters:
filename
- the filenameconfig
- the configuration- Throws:
IOException
- if an IOError occurs.
-
save
Saves the given configuration into a file specified by the given file object.- Parameters:
file
- the target fileconfig
- the configuration- Throws:
IOException
- if an IOError occurs.
-
save
Writes the configuration into the given output stream.- Parameters:
outStream
- the target output streamconfig
- the configuration- Throws:
IOException
- if writing fails.
-