Class ConfigurationPropertyNameAliases

java.lang.Object

org.springframework.boot.context.properties.source.ConfigurationPropertyNameAliases

All Implemented Interfaces:

Iterable<ConfigurationPropertyName>

public final class ConfigurationPropertyNameAliases
extends Object
implements Iterable<ConfigurationPropertyName>

Maintains a mapping of ConfigurationPropertyName aliases.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

See Also:

• ConfigurationPropertySource.withAliases(ConfigurationPropertyNameAliases)

Constructor Summary

Constructors

Constructor	Description
ConfigurationPropertyNameAliases()
ConfigurationPropertyNameAliases(String name, String... aliases)
ConfigurationPropertyNameAliases(ConfigurationPropertyName name, ConfigurationPropertyName... aliases)

Method Summary

Modifier and Type	Method	Description
void	addAliases(String name, String... aliases)
void	addAliases(ConfigurationPropertyName name, ConfigurationPropertyName... aliases)
List<ConfigurationPropertyName>	getAliases(ConfigurationPropertyName name)
@Nullable ConfigurationPropertyName	getNameForAlias(ConfigurationPropertyName alias)
Iterator<ConfigurationPropertyName>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ConfigurationPropertyNameAliases

public ConfigurationPropertyNameAliases()

ConfigurationPropertyNameAliases

public ConfigurationPropertyNameAliases(String name,
 String... aliases)

ConfigurationPropertyNameAliases

public ConfigurationPropertyNameAliases(ConfigurationPropertyName name,
 ConfigurationPropertyName... aliases)

Method Details

addAliases

public void addAliases(String name,
 String... aliases)

addAliases

public void addAliases(ConfigurationPropertyName name,
 ConfigurationPropertyName... aliases)

getAliases

public List<ConfigurationPropertyName> getAliases(ConfigurationPropertyName name)

getNameForAlias

public @Nullable ConfigurationPropertyName getNameForAlias(ConfigurationPropertyName alias)

iterator

public Iterator<ConfigurationPropertyName> iterator()

Specified by:

iterator in interface Iterable<ConfigurationPropertyName>