spring-boot/org.springframework.boot.context.config/ConfigDataLocation

ConfigDataLocation

class ConfigDataLocation : OriginProvider

A user specified location that can be resolved to one or more config data resources. A ConfigDataLocation is a simple wrapper around a String value. The exact format of the value will depend on the underlying technology, but is usually a URL like syntax consisting of a prefix and path. For example, crypt:somehost/somepath.

Locations can be mandatory or optional. Optional locations are prefixed with optional:.

Author

Phillip Webb

Since

2.4.0

Properties

OPTIONAL_PREFIX

val OPTIONAL_PREFIX: String = "optional:"

Prefix used to indicate that a ConfigDataResource is optional.

val origin: Origin

val value: String

Functions

open fun equals(obj: Any): Boolean

getNonPrefixedValue

open fun getNonPrefixedValue(prefix: String): String

Return getValue with the specified prefix removed.

open fun hashCode(): Int

open fun hasPrefix(prefix: String): Boolean

Return if getValue has the specified prefix.

open fun isOptional(): Boolean

Return if the location is optional and should ignore ConfigDataNotFoundException.

open fun of(location: String): ConfigDataLocation

Factory method to create a new ConfigDataLocation from a string.

open fun split(): Array<ConfigDataLocation>

Return an array of ConfigDataLocation elements built by splitting this ConfigDataLocation around a delimiter of ";".

open fun split(delimiter: String): Array<ConfigDataLocation>

Return an array of ConfigDataLocation elements built by splitting this ConfigDataLocation around the specified delimiter.

open fun toString(): String