spring-boot/org.springframework.boot.context.properties.source/ConfigurationPropertyName

ConfigurationPropertyName

class ConfigurationPropertyName : Comparable<T>

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

Author

Phillip Webb

Madhura Bhave

Since

2.0.0

See also

of(CharSequence)

ConfigurationPropertySource

Types

enum Form

The various forms that a non-indexed element value can take.

Properties

val EMPTY: ConfigurationPropertyName

An empty ConfigurationPropertyName.

Functions

open fun adapt(name: CharSequence, separator: Char): ConfigurationPropertyName

Create a ConfigurationPropertyName by adapting the given source.

open fun append(suffix: String): ConfigurationPropertyName

open fun append(suffix: ConfigurationPropertyName): ConfigurationPropertyName

Create a new ConfigurationPropertyName by appending the given suffix.

open fun chop(size: Int): ConfigurationPropertyName

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

open fun compareTo(other: ConfigurationPropertyName): Int

open fun equals(obj: Any): Boolean

open fun getElement(elementIndex: Int, form: ConfigurationPropertyName.Form): String

Return an element in the name in the given form.

open fun getLastElement(form: ConfigurationPropertyName.Form): String

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

getNumberOfElements

open fun getNumberOfElements(): Int

Return the total number of elements in the name.

open fun getParent(): ConfigurationPropertyName

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

open fun hashCode(): Int

hasIndexedElement

open fun hasIndexedElement(): Boolean

Return true if any element in the name is indexed.

open fun isAncestorOf(name: ConfigurationPropertyName): Boolean

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

open fun isEmpty(): Boolean

Returns true if this ConfigurationPropertyName is empty.

isLastElementIndexed

open fun isLastElementIndexed(): Boolean

Return if the last element in the name is indexed.

open fun isNumericIndex(elementIndex: Int): Boolean

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

open fun isParentOf(name: ConfigurationPropertyName): Boolean

Returns true if this element is an immediate parent of the specified name.

open fun isValid(name: CharSequence): Boolean

Returns if the given name is valid.

open fun of(name: CharSequence): ConfigurationPropertyName

Return a ConfigurationPropertyName for the specified string.

open fun ofIfValid(name: CharSequence): ConfigurationPropertyName

Return a ConfigurationPropertyName for the specified string or null if the name is not valid.

open fun subName(offset: Int): ConfigurationPropertyName

Return a new ConfigurationPropertyName by based on this name offset by specific element index.

open fun toString(): String