org.jfree.util

Class SortedConfigurationWriter


public class SortedConfigurationWriter
extends java.lang.Object

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

SortedConfigurationWriter()
The default constructor, does nothing.

Method Summary

protected 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

protected String getDescription(String key)
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

public void save(File file,
                 Configuration config)
            throws IOException
Saves the given configuration into a file specified by the given file object.
Parameters:
file - the target file
config - the configuration

save

public void save(OutputStream outStream,
                 Configuration config)
            throws IOException
Writes the configuration into the given output stream.
Parameters:
outStream - the target output stream
config - the configuration

save

public void save(String filename,
                 Configuration config)
            throws IOException
Saves the given configuration into a file specified by the given filename.
Parameters:
filename - the filename
config - the configuration