org.springframework.core.env

Class MutablePropertySources

java.lang.Object

org.springframework.core.env.MutablePropertySources

All Implemented Interfaces:

java.lang.Iterable<PropertySource<?>>, PropertySources

public class MutablePropertySources
extends java.lang.Object
implements PropertySources

Default implementation of the PropertySources interface. Allows manipulation of contained property sources and provides a constructor for copying an existing PropertySources instance.

Where precedence is mentioned in methods such as addFirst(org.springframework.core.env.PropertySource<?>) and addLast(org.springframework.core.env.PropertySource<?>), this is with regard to the order in which property sources will be searched when resolving a given property with a PropertyResolver.

Since:

3.1

Author:

Chris Beams, Juergen Hoeller

See Also:

PropertySourcesPropertyResolver

Field Summary

Fields

Modifier and Type	Field and Description
private Log	logger
private java.util.List<PropertySource<?>>	propertySourceList

Constructor Summary

Constructors

Constructor and Description
MutablePropertySources() Create a new MutablePropertySources object.
MutablePropertySources(Log logger) Create a new MutablePropertySources object and inherit the given logger, usually from an enclosing Environment.
MutablePropertySources(PropertySources propertySources) Create a new MutablePropertySources from the given propertySources object, preserving the original order of contained PropertySource objects.

Method Summary

Modifier and Type	Method and Description
void	addAfter(java.lang.String relativePropertySourceName, PropertySource<?> propertySource) Add the given property source object with precedence immediately lower than the named relative property source.
private void	addAtIndex(int index, PropertySource<?> propertySource) Add the given property source at a particular index in the list.
void	addBefore(java.lang.String relativePropertySourceName, PropertySource<?> propertySource) Add the given property source object with precedence immediately higher than the named relative property source.
void	addFirst(PropertySource<?> propertySource) Add the given property source object with highest precedence.
void	addLast(PropertySource<?> propertySource) Add the given property source object with lowest precedence.
protected void	assertLegalRelativeAddition(java.lang.String relativePropertySourceName, PropertySource<?> propertySource) Ensure that the given property source is not being added relative to itself.
private int	assertPresentAndGetIndex(java.lang.String name) Assert that the named property source is present and return its index.
boolean	contains(java.lang.String name) Return whether a property source with the given name is contained.
PropertySource<?>	get(java.lang.String name) Return the property source with the given name, null if not found.
java.util.Iterator<PropertySource<?>>	iterator()
int	precedenceOf(PropertySource<?> propertySource) Return the precedence of the given property source, -1 if not found.
PropertySource<?>	remove(java.lang.String name) Remove and return the property source with the given name, null if not found.
protected void	removeIfPresent(PropertySource<?> propertySource) Remove the given property source if it is present.
void	replace(java.lang.String name, PropertySource<?> propertySource) Replace the property source with the given name with the given property source object.
int	size() Return the number of PropertySource objects contained.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

logger

private final Log logger

propertySourceList

private final java.util.List<PropertySource<?>> propertySourceList

Constructor Detail

MutablePropertySources

public MutablePropertySources()

Create a new MutablePropertySources object.

MutablePropertySources

public MutablePropertySources(PropertySources propertySources)

Create a new MutablePropertySources from the given propertySources object, preserving the original order of contained PropertySource objects.

MutablePropertySources

MutablePropertySources(Log logger)

Create a new MutablePropertySources object and inherit the given logger, usually from an enclosing Environment.

Method Detail

contains

public boolean contains(java.lang.String name)

Description copied from interface: PropertySources

Return whether a property source with the given name is contained.

Specified by:

contains in interface PropertySources

Parameters:

name - the name of the property source to find

get

public PropertySource<?> get(java.lang.String name)

Description copied from interface: PropertySources

Return the property source with the given name, null if not found.

Specified by:

get in interface PropertySources

Parameters:

name - the name of the property source to find

iterator

public java.util.Iterator<PropertySource<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<PropertySource<?>>

addFirst

public void addFirst(PropertySource<?> propertySource)

Add the given property source object with highest precedence.

addLast

public void addLast(PropertySource<?> propertySource)

Add the given property source object with lowest precedence.

addBefore

public void addBefore(java.lang.String relativePropertySourceName,
                      PropertySource<?> propertySource)

Add the given property source object with precedence immediately higher than the named relative property source.

addAfter

public void addAfter(java.lang.String relativePropertySourceName,
                     PropertySource<?> propertySource)

Add the given property source object with precedence immediately lower than the named relative property source.

precedenceOf

public int precedenceOf(PropertySource<?> propertySource)

Return the precedence of the given property source, -1 if not found.

remove

public PropertySource<?> remove(java.lang.String name)

Remove and return the property source with the given name, null if not found.

Parameters:

name - the name of the property source to find and remove

replace

public void replace(java.lang.String name,
                    PropertySource<?> propertySource)

Replace the property source with the given name with the given property source object.

Parameters:

name - the name of the property source to find and replace

propertySource - the replacement property source

Throws:

java.lang.IllegalArgumentException - if no property source with the given name is present

See Also:

contains(java.lang.String)

size

public int size()

Return the number of PropertySource objects contained.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

assertLegalRelativeAddition

protected void assertLegalRelativeAddition(java.lang.String relativePropertySourceName,
                                           PropertySource<?> propertySource)

Ensure that the given property source is not being added relative to itself.

removeIfPresent

protected void removeIfPresent(PropertySource<?> propertySource)

Remove the given property source if it is present.

addAtIndex

private void addAtIndex(int index,
                        PropertySource<?> propertySource)

Add the given property source at a particular index in the list.

assertPresentAndGetIndex

private int assertPresentAndGetIndex(java.lang.String name)

Assert that the named property source is present and return its index.

Parameters:

name - the name of the property source to find

Throws:

java.lang.IllegalArgumentException - if the named property source is not present