org.springframework.core.io.support

Class ResourcePropertySource

java.lang.Object

org.springframework.core.env.PropertySource<T>

org.springframework.core.env.EnumerablePropertySource<java.util.Map<java.lang.String,java.lang.Object>>

org.springframework.core.env.MapPropertySource

org.springframework.core.env.PropertiesPropertySource

org.springframework.core.io.support.ResourcePropertySource

public class ResourcePropertySource
extends PropertiesPropertySource

Subclass of PropertiesPropertySource that loads a Properties object from a given Resource or resource location such as "classpath:/com/myco/foo.properties" or "file:/path/to/file.xml".

Both traditional and XML-based properties file formats are supported; however, in order for XML processing to take effect, the underlying Resource's getFilename() method must return a non-null value that ends in ".xml".

Since:

3.1

Author:

Chris Beams, Juergen Hoeller

See Also:

Resource, EncodedResource

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.env.PropertySource

PropertySource.StubPropertySource

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	resourceName The original resource name, if different from the given name

Fields inherited from class org.springframework.core.env.PropertySource

logger, name, source

Constructor Summary

Constructors

Modifier	Constructor and Description
	ResourcePropertySource(EncodedResource resource) Create a PropertySource based on Properties loaded from the given resource.
	ResourcePropertySource(Resource resource) Create a PropertySource based on Properties loaded from the given resource.
	ResourcePropertySource(java.lang.String location) Create a PropertySource based on Properties loaded from the given resource location.
	ResourcePropertySource(java.lang.String location, java.lang.ClassLoader classLoader) Create a PropertySource based on Properties loaded from the given resource location and use the given class loader to load the resource, assuming it is prefixed with classpath:.
	ResourcePropertySource(java.lang.String name, EncodedResource resource) Create a PropertySource having the given name based on Properties loaded from the given encoded resource.
	ResourcePropertySource(java.lang.String name, Resource resource) Create a PropertySource having the given name based on Properties loaded from the given encoded resource.
	ResourcePropertySource(java.lang.String name, java.lang.String location) Create a PropertySource having the given name based on Properties loaded from the given resource location.
	ResourcePropertySource(java.lang.String name, java.lang.String location, java.lang.ClassLoader classLoader) Create a PropertySource having the given name based on Properties loaded from the given resource location and using the given class loader to load the resource (assuming it is prefixed with classpath:).
private	ResourcePropertySource(java.lang.String name, java.lang.String resourceName, java.util.Map<java.lang.String,java.lang.Object> source)

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	getNameForResource(Resource resource) Return the description for the given Resource; if the description is empty, return the class name of the resource plus its identity hash code.
ResourcePropertySource	withName(java.lang.String name) Return a potentially adapted variant of this ResourcePropertySource, overriding the previously given (or derived) name with the specified name.
ResourcePropertySource	withResourceName() Return a potentially adapted variant of this ResourcePropertySource, overriding the previously given name (if any) with the original resource name (equivalent to the name generated by the name-less constructor variants).

Methods inherited from class org.springframework.core.env.MapPropertySource

containsProperty, getProperty, getPropertyNames

Methods inherited from class org.springframework.core.env.PropertySource

equals, getName, getSource, hashCode, named, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

resourceName

private final java.lang.String resourceName

The original resource name, if different from the given name

Constructor Detail

ResourcePropertySource

public ResourcePropertySource(java.lang.String name,
                              EncodedResource resource)
                       throws java.io.IOException

Create a PropertySource having the given name based on Properties loaded from the given encoded resource.

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(EncodedResource resource)
                       throws java.io.IOException

Create a PropertySource based on Properties loaded from the given resource. The name of the PropertySource will be generated based on the description of the given resource.

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(java.lang.String name,
                              Resource resource)
                       throws java.io.IOException

Create a PropertySource having the given name based on Properties loaded from the given encoded resource.

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(Resource resource)
                       throws java.io.IOException

Create a PropertySource based on Properties loaded from the given resource. The name of the PropertySource will be generated based on the description of the given resource.

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(java.lang.String name,
                              java.lang.String location,
                              java.lang.ClassLoader classLoader)
                       throws java.io.IOException

Create a PropertySource having the given name based on Properties loaded from the given resource location and using the given class loader to load the resource (assuming it is prefixed with classpath:).

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(java.lang.String location,
                              java.lang.ClassLoader classLoader)
                       throws java.io.IOException

Create a PropertySource based on Properties loaded from the given resource location and use the given class loader to load the resource, assuming it is prefixed with classpath:. The name of the PropertySource will be generated based on the description of the resource.

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(java.lang.String name,
                              java.lang.String location)
                       throws java.io.IOException

Create a PropertySource having the given name based on Properties loaded from the given resource location. The default thread context class loader will be used to load the resource (assuming the location string is prefixed with classpath:.

Throws:

java.io.IOException

ResourcePropertySource

public ResourcePropertySource(java.lang.String location)
                       throws java.io.IOException

Create a PropertySource based on Properties loaded from the given resource location. The name of the PropertySource will be generated based on the description of the resource.

Throws:

java.io.IOException

ResourcePropertySource

private ResourcePropertySource(java.lang.String name,
                               java.lang.String resourceName,
                               java.util.Map<java.lang.String,java.lang.Object> source)

Method Detail

withName

public ResourcePropertySource withName(java.lang.String name)

Return a potentially adapted variant of this ResourcePropertySource, overriding the previously given (or derived) name with the specified name.

Since:

4.0.4

withResourceName

public ResourcePropertySource withResourceName()

Return a potentially adapted variant of this ResourcePropertySource, overriding the previously given name (if any) with the original resource name (equivalent to the name generated by the name-less constructor variants).

Since:

4.1

getNameForResource

private static java.lang.String getNameForResource(Resource resource)

Return the description for the given Resource; if the description is empty, return the class name of the resource plus its identity hash code.

See Also:

Resource.getDescription()