org.springframework.core.io.support

Class ResourcePropertiesPersister

java.lang.Object

org.springframework.util.DefaultPropertiesPersister

org.springframework.core.io.support.ResourcePropertiesPersister

All Implemented Interfaces:

PropertiesPersister

public class ResourcePropertiesPersister
extends DefaultPropertiesPersister

Spring-aware subclass of the plain DefaultPropertiesPersister, adding a conditional check for disabled XML support through the shared "spring.xml.ignore" property.

This is the standard implementation used in Spring's resource support.

Since:

5.3

Author:

Juergen Hoeller, Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
static ResourcePropertiesPersister	INSTANCE A convenient constant for a default ResourcePropertiesPersister instance, as used in Spring's common resource support.

Constructor Summary

Constructors

Constructor and Description
ResourcePropertiesPersister()

Method Summary

Modifier and Type	Method and Description
void	loadFromXml(Properties props, InputStream is) Load properties from the given XML InputStream into the given Properties object.
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.

Methods inherited from class org.springframework.util.DefaultPropertiesPersister

load, load, store, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final ResourcePropertiesPersister INSTANCE

A convenient constant for a default ResourcePropertiesPersister instance, as used in Spring's common resource support.

Since:

5.3

Constructor Detail

ResourcePropertiesPersister

public ResourcePropertiesPersister()

Method Detail

loadFromXml

public void loadFromXml(Properties props,
                        InputStream is)
                 throws IOException

Description copied from interface: PropertiesPersister

Load properties from the given XML InputStream into the given Properties object.

Specified by:

loadFromXml in interface PropertiesPersister

Overrides:

loadFromXml in class DefaultPropertiesPersister

Parameters:

props - the Properties object to load into

is - the InputStream to load from

Throws:

IOException - in case of I/O errors

See Also:

Properties.loadFromXML(java.io.InputStream)

storeToXml

public void storeToXml(Properties props,
                       OutputStream os,
                       String header)
                throws IOException

Description copied from interface: PropertiesPersister

Write the contents of the given Properties object to the given XML OutputStream.

Specified by:

storeToXml in interface PropertiesPersister

Overrides:

storeToXml in class DefaultPropertiesPersister

Parameters:

props - the Properties object to store

os - the OutputStream to write to

header - the description of the property list

Throws:

IOException - in case of I/O errors

See Also:

Properties.storeToXML(java.io.OutputStream, String)

storeToXml

public void storeToXml(Properties props,
                       OutputStream os,
                       String header,
                       String encoding)
                throws IOException

Description copied from interface: PropertiesPersister

Write the contents of the given Properties object to the given XML OutputStream.

Specified by:

storeToXml in interface PropertiesPersister

Overrides:

storeToXml in class DefaultPropertiesPersister

Parameters:

props - the Properties object to store

os - the OutputStream to write to

header - the description of the property list

encoding - the encoding to use

Throws:

IOException - in case of I/O errors

See Also:

Properties.storeToXML(java.io.OutputStream, String, String)