Package org.springframework.util
Interface PropertiesPersister
- All Known Implementing Classes:
DefaultPropertiesPersister
public interface PropertiesPersister
Strategy interface for persistingjava.util.Properties
, allowing for pluggable parsing strategies.The default implementation is DefaultPropertiesPersister, providing the native parsing of
java.util.Properties
, but allowing for reading from any Reader and writing to any Writer (which allows to specify an encoding for a properties file).- Since:
- 10.03.2004
- Author:
- Juergen Hoeller
- See Also:
DefaultPropertiesPersister
,Properties
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
load(Properties props, InputStream is)
Load properties from the given InputStream into the given Properties object.void
load(Properties props, Reader reader)
Load properties from the given Reader into the given Properties object.void
loadFromXml(Properties props, InputStream is)
Load properties from the given XML InputStream into the given Properties object.void
store(Properties props, OutputStream os, String header)
Write the contents of the given Properties object to the given OutputStream.void
store(Properties props, Writer writer, String header)
Write the contents of the given Properties object to the given Writer.void
storeToXml(Properties props, OutputStream os, String header)
Write the contents of the given Properties object to the given XML OutputStream.void
storeToXml(Properties props, OutputStream os, String header, String encoding)
Write the contents of the given Properties object to the given XML OutputStream.
Method Detail
load
void load(Properties props, InputStream is) throws IOException
Load properties from the given InputStream into the given Properties object.- Parameters:
props
- the Properties object to load intois
- the InputStream to load from- Throws:
IOException
- in case of I/O errors- See Also:
Properties.load(java.io.Reader)
load
void load(Properties props, Reader reader) throws IOException
Load properties from the given Reader into the given Properties object.- Parameters:
props
- the Properties object to load intoreader
- the Reader to load from- Throws:
IOException
- in case of I/O errors
store
void store(Properties props, OutputStream os, String header) throws IOException
Write the contents of the given Properties object to the given OutputStream.- Parameters:
props
- the Properties object to storeos
- the OutputStream to write toheader
- the description of the property list- Throws:
IOException
- in case of I/O errors- See Also:
Properties.store(java.io.Writer, java.lang.String)
store
void store(Properties props, Writer writer, String header) throws IOException
Write the contents of the given Properties object to the given Writer.- Parameters:
props
- the Properties object to storewriter
- the Writer to write toheader
- the description of the property list- Throws:
IOException
- in case of I/O errors
loadFromXml
void loadFromXml(Properties props, InputStream is) throws IOException
Load properties from the given XML InputStream into the given Properties object.- Parameters:
props
- the Properties object to load intois
- the InputStream to load from- Throws:
IOException
- in case of I/O errors- See Also:
Properties.loadFromXML(java.io.InputStream)
storeToXml
void storeToXml(Properties props, OutputStream os, String header) throws IOException
Write the contents of the given Properties object to the given XML OutputStream.- Parameters:
props
- the Properties object to storeos
- the OutputStream to write toheader
- the description of the property list- Throws:
IOException
- in case of I/O errors- See Also:
Properties.storeToXML(java.io.OutputStream, String)
storeToXml
void storeToXml(Properties props, OutputStream os, String header, String encoding) throws IOException
Write the contents of the given Properties object to the given XML OutputStream.- Parameters:
props
- the Properties object to storeos
- the OutputStream to write toencoding
- the encoding to useheader
- the description of the property list- Throws:
IOException
- in case of I/O errors- See Also:
Properties.storeToXML(java.io.OutputStream, String, String)