Package org.springframework.boot.context.properties.source

Class ConfigurationPropertyName

java.lang.Object

org.springframework.boot.context.properties.source.ConfigurationPropertyName

All Implemented Interfaces:

Comparable<ConfigurationPropertyName>

public final class ConfigurationPropertyName
extends Object
implements Comparable<ConfigurationPropertyName>

A configuration property name composed of elements separated by dots. User created names may contain the characters "a-z" "0-9" and "-", they must be lower-case and must start with an alphanumeric character. The "-" is used purely for formatting, i.e. "foo-bar" and "foobar" are considered equivalent.

The "[" and "]" characters may be used to indicate an associative index(i.e. a Map key or a Collection index). Indexes names are not restricted and are considered case-sensitive.

Here are some typical examples:

• spring.main.banner-mode
• server.hosts[0].name
• log[org.springboot].level

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

See Also:

• of(CharSequence)
• ConfigurationPropertySource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConfigurationPropertyName.Form	The various forms that a non-indexed element value can take.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationPropertyName	EMPTY	An empty ConfigurationPropertyName.

Method Summary

Modifier and Type

Method

Description

static ConfigurationPropertyName

adapt(CharSequence name, char separator)

Create a ConfigurationPropertyName by adapting the given source.

ConfigurationPropertyName

append(String suffix)

Create a new ConfigurationPropertyName by appending the given suffix.

ConfigurationPropertyName

append(ConfigurationPropertyName suffix)

Create a new ConfigurationPropertyName by appending the given suffix.

ConfigurationPropertyName

chop(int size)

Return a new ConfigurationPropertyName by chopping this name to the given size.

int

compareTo(ConfigurationPropertyName other)

boolean

equals(Object obj)

String

getElement(int elementIndex, ConfigurationPropertyName.Form form)

Return an element in the name in the given form.

String

getLastElement(ConfigurationPropertyName.Form form)

Return the last element in the name in the given form.

int

getNumberOfElements()

Return the total number of elements in the name.

ConfigurationPropertyName

getParent()

Return the parent of this ConfigurationPropertyName or EMPTY if there is no parent.

int

hashCode()

boolean

hasIndexedElement()

Return true if any element in the name is indexed.

boolean

isAncestorOf(ConfigurationPropertyName name)

Returns true if this element is an ancestor (immediate or nested parent) of the specified name.

boolean

isEmpty()

Returns true if this ConfigurationPropertyName is empty.

boolean

isLastElementIndexed()

Return if the last element in the name is indexed.

boolean

isNumericIndex(int elementIndex)

Return if the element in the name is indexed and numeric.

boolean

isParentOf(