Interface PropertiesConfiguration.IOFactory
-
- All Known Implementing Classes:
PropertiesConfiguration.DefaultIOFactory
,PropertiesConfiguration.JupIOFactory
- Enclosing class:
- PropertiesConfiguration
public static interface PropertiesConfiguration.IOFactory
Definition of an interface that allows customization of read and write operations.
For reading and writing properties files the inner classes
PropertiesReader
andPropertiesWriter
are used. This interface defines factory methods for creating both aPropertiesReader
and aPropertiesWriter
. An object implementing this interface can be passed to thesetIOFactory()
method ofPropertiesConfiguration
. Every time the configuration is read or written theIOFactory
is asked to create the appropriate reader or writer object. This provides an opportunity to inject custom reader or writer implementations.- Since:
- 1.7
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PropertiesConfiguration.PropertiesReader
createPropertiesReader(java.io.Reader in)
Creates aPropertiesReader
for reading a properties file.PropertiesConfiguration.PropertiesWriter
createPropertiesWriter(java.io.Writer out, ListDelimiterHandler handler)
Creates aPropertiesWriter
for writing a properties file.
-
-
-
Method Detail
-
createPropertiesReader
PropertiesConfiguration.PropertiesReader createPropertiesReader(java.io.Reader in)
Creates aPropertiesReader
for reading a properties file. This method is called whenever thePropertiesConfiguration
is loaded. The reader returned by this method is then used for parsing the properties file.- Parameters:
in
- the underlying reader (of the properties file)- Returns:
- the
PropertiesReader
for loading the configuration
-
createPropertiesWriter
PropertiesConfiguration.PropertiesWriter createPropertiesWriter(java.io.Writer out, ListDelimiterHandler handler)
Creates aPropertiesWriter
for writing a properties file. This method is called before thePropertiesConfiguration
is saved. The writer returned by this method is then used for writing the properties file.- Parameters:
out
- the underlying writer (to the properties file)handler
- the list delimiter delimiter for list parsing- Returns:
- the
PropertiesWriter
for saving the configuration
-
-