ConfigurationPropertyName (spring-boot 3.3.5)

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

See Also:

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(ConfigurationPropertyName name)

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

static boolean

isValid(CharSequence name)

Returns if the given name is valid.

static ConfigurationPropertyName

of(CharSequence name)

Return a ConfigurationPropertyName for the specified string.

static ConfigurationPropertyName

ofIfValid(CharSequence name)

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

ConfigurationPropertyName

subName(int offset)

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

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- EMPTY
  
  public static final ConfigurationPropertyName EMPTY
  
  An empty ConfigurationPropertyName.
Method Details
- isEmpty
  
  public boolean isEmpty()
  
  Returns true if this ConfigurationPropertyName is empty.
  
  Returns:
  
  true if the name is empty
- isLastElementIndexed
  
  public boolean isLastElementIndexed()
  
  Return if the last element in the name is indexed.
  
  Returns:
  
  true if the last element is indexed
- hasIndexedElement
  
  public boolean hasIndexedElement()
  
  Return true if any element in the name is indexed.
  
  Returns:
  
  if the element has one or more indexed elements
  
  Since:
  
  2.2.10
- isNumericIndex
  
  public boolean isNumericIndex(int elementIndex)
  
  Return if the element in the name is indexed and numeric.
  
  Parameters:
  
  elementIndex - the index of the element
  
  Returns:
  
  true if the element is indexed and numeric
- getLastElement
  
  public String getLastElement(ConfigurationPropertyName.Form form)
  
  Return the last element in the name in the given form.
  
  Parameters:
  
  form - the form to return
  
  Returns:
  
  the last element
- getElement
  
  public String getElement(int elementIndex, ConfigurationPropertyName.Form form)
  
  Return an element in the name in the given form.
  
  Parameters:
  
  elementIndex - the element index
  
  form - the form to return
  
  Returns:
  
  the last element
- getNumberOfElements
  
  public int getNumberOfElements()
  
  Return the total number of elements in the name.
  
  Returns:
  
  the number of elements
- append
  
  public ConfigurationPropertyName append(String suffix)
  
  Create a new ConfigurationPropertyName by appending the given suffix.
  
  Parameters:
  
  suffix - the elements to append
  
  Returns:
  
  a new ConfigurationPropertyName
  
  Throws:
  
  InvalidConfigurationPropertyNameException - if the result is not valid
- append
  
  public ConfigurationPropertyName append(ConfigurationPropertyName suffix)
  
  Create a new ConfigurationPropertyName by appending the given suffix.
  
  Parameters:
  
  suffix - the elements to append
  
  Returns:
  
  a new ConfigurationPropertyName
  
  Since:
  
  2.5.0
- getParent
  
  public ConfigurationPropertyName getParent()
  
  Return the parent of this ConfigurationPropertyName or EMPTY if there is no parent.
  
  Returns:
  
  the parent name
- chop
  
  public ConfigurationPropertyName chop(int size)
  
  Return a new ConfigurationPropertyName by chopping this name to the given size. For example, chop(1) on the name foo.bar will return foo.
  
  Parameters:
  
  size - the size to chop
  
  Returns:
  
  the chopped name
- subName
  
  public ConfigurationPropertyName subName(int offset)
  
  Return a new ConfigurationPropertyName by based on this name offset by specific element index. For example, chop(1) on the name foo.bar will return bar.
  
  Parameters:
  
  offset - the element offset
  
  Returns:
  
  the sub name
  
  Since:
  
  2.5.0
- isParentOf
  
  public boolean isParentOf(ConfigurationPropertyName name)
  
  Returns true if this element is an immediate parent of the specified name.
  
  Parameters:
  
  name - the name to check
  
  Returns:
  
  true if this name is an ancestor
- isAncestorOf
  
  public boolean isAncestorOf(ConfigurationPropertyName name)
  
  Returns true if this element is an ancestor (immediate or nested parent) of the specified name.
  
  Parameters:
  
  name - the name to check
  
  Returns:
  
  true if this name is an ancestor
- compareTo
  
  public int compareTo(ConfigurationPropertyName other)
  
  Specified by:
  
  compareTo in interface Comparable<ConfigurationPropertyName>
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- isValid
  
  public static boolean isValid(CharSequence name)
  
  Returns if the given name is valid. If this method returns true then the name may be used with of(CharSequence) without throwing an exception.
  
  Parameters:
  
  name - the name to test
  
  Returns:
  
  true if the name is valid
- of
  
  public static ConfigurationPropertyName of(CharSequence name)
  
  Return a ConfigurationPropertyName for the specified string.
  
  Parameters:
  
  name - the source name
  
  Returns:
  
  a ConfigurationPropertyName instance
  
  Throws:
  
  InvalidConfigurationPropertyNameException - if the name is not valid
- ofIfValid
  
  public static ConfigurationPropertyName ofIfValid(CharSequence name)
  
  Return a ConfigurationPropertyName for the specified string or null if the name is not valid.
  
  Parameters:
  
  name - the source name
  
  Returns:
  
  a ConfigurationPropertyName instance
  
  Since:
  
  2.3.1
- adapt
  
  public static ConfigurationPropertyName adapt(CharSequence name, char separator)
  
  Create a ConfigurationPropertyName by adapting the given source. See adapt(CharSequence, char, Function) for details.
  
  Parameters:
  
  name - the name to parse
  
  separator - the separator used to split the name
  
  Returns:
  
  a ConfigurationPropertyName

Class ConfigurationPropertyName

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

EMPTY

Method Details

isEmpty

isLastElementIndexed

hasIndexedElement

isNumericIndex

getLastElement

getElement

getNumberOfElements

append

append

getParent

chop

subName

isParentOf

isAncestorOf

compareTo

equals

hashCode

toString

isValid

of

ofIfValid

adapt