ConfigDataLocationResolver (spring-boot 2.4.11)

Type Parameters:

R - the location type

All Known Implementing Classes:

ConfigTreeConfigDataLocationResolver, StandardConfigDataLocationResolver
```
public interface ConfigDataLocationResolver<R extends ConfigDataResource>
```
Strategy interface used to resolve locations into one or more resources. Implementations should be added as a spring.factories entries. The following constructor parameter types are supported:
- Log or DeferredLogFactory - if the resolver needs deferred logging
- Binder - if the resolver needs to obtain values from the initial Environment
- ResourceLoader - if the resolver needs a resource loader
- ConfigurableBootstrapContext - A bootstrap context that can be used to store objects that may be expensive to create, or need to be shared (BootstrapContext or BootstrapRegistry may also be used).
Resolvers may implement Ordered or use the @Order annotation. The first resolver that supports the given location will be used.
Since:

2.4.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`isResolvable(ConfigDataLocationResolverContext context, ConfigDataLocation location)` Returns if the specified location address can be resolved by this resolver.
`java.util.List<R>`	`resolve(ConfigDataLocationResolverContext context, ConfigDataLocation location)` Resolve a `ConfigDataLocation` into one or more `ConfigDataResource` instances.
`default java.util.List<R>`	`resolveProfileSpecific(ConfigDataLocationResolverContext context, ConfigDataLocation location, Profiles profiles)` Resolve a `ConfigDataLocation` into one or more `ConfigDataResource` instances based on available profiles.

- Method Detail
  - isResolvable
```
boolean isResolvable(ConfigDataLocationResolverContext context,
                     ConfigDataLocation location)
```
    Returns if the specified location address can be resolved by this resolver.
    
    Parameters:
    
    context - the location resolver context
    
    location - the location to check.
    
    Returns:
    
    if the location is supported by this resolver
  - resolve
```
java.util.List<R> resolve(ConfigDataLocationResolverContext context,
                          ConfigDataLocation location)
                   throws ConfigDataLocationNotFoundException,
                          ConfigDataResourceNotFoundException
```
    Resolve a ConfigDataLocation into one or more ConfigDataResource instances.
    
    Parameters:
    
    context - the location resolver context
    
    location - the location that should be resolved
    
    Returns:
    
    a list of resources in ascending priority order.
    
    Throws:
    
    ConfigDataLocationNotFoundException - on a non-optional location that cannot be found
    
    ConfigDataResourceNotFoundException - if a resolved resource cannot be found
  - resolveProfileSpecific
```
default java.util.List<R> resolveProfileSpecific(ConfigDataLocationResolverContext context,
                                                 ConfigDataLocation location,
                                                 Profiles profiles)
                                          throws ConfigDataLocationNotFoundException
```
    Resolve a ConfigDataLocation into one or more ConfigDataResource instances based on available profiles. This method is called once profiles have been deduced from the contributed values. By default this method returns an empty list.
    
    Parameters:
    
    context - the location resolver context
    
    location - the location that should be resolved
    
    profiles - profile information
    
    Returns:
    
    a list of resolved locations in ascending priority order.
    
    Throws:
    
    ConfigDataLocationNotFoundException - on a non-optional location that cannot be found

Interface ConfigDataLocationResolver<R extends ConfigDataResource>

Method Summary

Method Detail

isResolvable

resolve

resolveProfileSpecific