ConfigDataLocation (spring-boot 2.6.12)

java.lang.Object
- org.springframework.boot.context.config.ConfigDataLocation

All Implemented Interfaces:

OriginProvider
```
public final class ConfigDataLocation
extends java.lang.Object
implements 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:.

Since:

2.4.0

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String OPTIONAL_PREFIX
Prefix used to indicate that a ConfigDataResource is optional.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`OPTIONAL_PREFIX` Prefix used to indicate that a `ConfigDataResource` is optional.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getNonPrefixedValue(java.lang.String prefix)` Return `getValue()` with the specified prefix removed.
`Origin`	`getOrigin()` Return the source origin or `null` if the origin is not known.
`java.lang.String`	`getValue()` Return the value of the location (always excluding any user specified `optional:` prefix).
`int`	`hashCode()`
`boolean`	`hasPrefix(java.lang.String prefix)` Return if `getValue()` has the specified prefix.
`boolean`	`isOptional()` Return if the location is optional and should ignore `ConfigDataNotFoundException`.
`static ConfigDataLocation`	`of(java.lang.String location)` Factory method to create a new `ConfigDataLocation` from a string.
`ConfigDataLocation[]`	`split()` Return an array of `ConfigDataLocation` elements built by splitting this `ConfigDataLocation` around a delimiter of `";"`.
`ConfigDataLocation[]`	`split(java.lang.String delimiter)` Return an array of `ConfigDataLocation` elements built by splitting this `ConfigDataLocation` around the specified delimiter.
`java.lang.String`	`toString()`

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

- Field Detail
  - OPTIONAL_PREFIX
```
public static final java.lang.String OPTIONAL_PREFIX
```
    Prefix used to indicate that a ConfigDataResource is optional.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isOptional
```
public boolean isOptional()
```
    Return if the location is optional and should ignore ConfigDataNotFoundException.
    
    Returns:
    
    if the location is optional
  - getValue
```
public java.lang.String getValue()
```
    Return the value of the location (always excluding any user specified optional: prefix).
    
    Returns:
    
    the location value
  - hasPrefix
```
public boolean hasPrefix(java.lang.String prefix)
```
    Return if getValue() has the specified prefix.
    
    Parameters:
    
    prefix - the prefix to check
    
    Returns:
    
    if the value has the prefix
  - getNonPrefixedValue
```
public java.lang.String getNonPrefixedValue(java.lang.String prefix)
```
    Return getValue() with the specified prefix removed. If the location does not have the given prefix then the getValue() is returned unchanged.
    
    Parameters:
    
    prefix - the prefix to check
    
    Returns:
    
    the value with the prefix removed
  - getOrigin
```
public Origin getOrigin()
```
    Description copied from interface: OriginProvider
    
    Return the source origin or null if the origin is not known.
    
    Specified by:
    
    getOrigin in interface OriginProvider
    
    Returns:
    
    the origin or null
  - split
```
public ConfigDataLocation[] split()
```
    Return an array of ConfigDataLocation elements built by splitting this ConfigDataLocation around a delimiter of ";".
    
    Returns:
    
    the split locations
    
    Since:
    
    2.4.7
  - split
```
public ConfigDataLocation[] split(java.lang.String delimiter)
```
    Return an array of ConfigDataLocation elements built by splitting this ConfigDataLocation around the specified delimiter.
    
    Parameters:
    
    delimiter - the delimiter to split on
    
    Returns:
    
    the split locations
    
    Since:
    
    2.4.7
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - of
```
public static ConfigDataLocation of(java.lang.String location)
```
    Factory method to create a new ConfigDataLocation from a string.
    
    Parameters:
    
    location - the location string
    
    Returns:
    
    a ConfigDataLocation instance or null if no location was provided

Class ConfigDataLocation

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPTIONAL_PREFIX

Method Detail

isOptional

getValue

hasPrefix

getNonPrefixedValue

getOrigin

split

split

equals

hashCode

toString

of