Top Description Methods
org.springframework.core.io.support

public Interface PropertySourceFactory

Known Direct Implementers
org.springframework.core.io.support.DefaultPropertySourceFactory
Imports
java.io.IOException, org.springframework.core.env.PropertySource, org.springframework.lang.Nullable
Strategy interface for creating resource-based PropertySource wrappers.
Author
Juergen Hoeller
Since
4.3
See Also
DefaultPropertySourceFactory, ResourcePropertySource

Method Summary

Modifier and TypeMethod and Description
public PropertySource<?>

Returns:

the new PropertySource (never null)
createPropertySource(String
the name of the property source (can be null in which case the factory implementation will have to generate a name based on the given resource)
name, EncodedResource
the resource (potentially encoded) to wrap
resource)

Create a PropertySource that wraps the given resource.

Method Detail

createPropertySourceback to summary
public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException

Create a PropertySource that wraps the given resource.

Implementations will typically create ResourcePropertySource instances, with PropertySourceProcessor automatically adapting property source names via ResourcePropertySource#withResourceName() if necessary, e.g. when combining multiple sources for the same name into a org.springframework.core.env.CompositePropertySource. Custom implementations with custom PropertySource types need to make sure to expose distinct enough names, possibly deriving from ResourcePropertySource where possible.

Parameters
name:String

the name of the property source (can be null in which case the factory implementation will have to generate a name based on the given resource)

resource:EncodedResource

the resource (potentially encoded) to wrap

Returns:PropertySource<?>

the new PropertySource (never null)

Exceptions
IOException:
if resource resolution failed