org.springframework.boot.context.config

Class StandardConfigDataLocationResolver

java.lang.Object

org.springframework.boot.context.config.StandardConfigDataLocationResolver

All Implemented Interfaces:

ConfigDataLocationResolver<StandardConfigDataResource>, Ordered

public class StandardConfigDataLocationResolver
extends Object
implements ConfigDataLocationResolver<StandardConfigDataResource>, Ordered

ConfigDataLocationResolver for standard locations.

Since:

2.4.0

Author:

Madhura Bhave, Phillip Webb, Scott Frederick

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
StandardConfigDataLocationResolver(Log logger, Binder binder, ResourceLoader resourceLoader) Create a new StandardConfigDataLocationResolver instance.

Method Summary

Modifier and Type	Method and Description
int	getOrder()
boolean	isResolvable(ConfigDataLocationResolverContext context, ConfigDataLocation location) Returns if the specified location address can be resolved by this resolver.
List<StandardConfigDataResource>	resolve(ConfigDataLocationResolverContext context, ConfigDataLocation location) Resolve a ConfigDataLocation into one or more ConfigDataResource instances.
List<StandardConfigDataResource>	resolveProfileSpecific(ConfigDataLocationResolverContext context, ConfigDataLocation location, Profiles profiles) Resolve a ConfigDataLocation into one or more ConfigDataResource instances based on available profiles.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardConfigDataLocationResolver

public StandardConfigDataLocationResolver(Log logger,
                                          Binder binder,
                                          ResourceLoader resourceLoader)

Create a new StandardConfigDataLocationResolver instance.

Parameters:

logger - the logger to use

binder - a binder backed by the initial Environment

resourceLoader - a ResourceLoader used to load resources

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

isResolvable

public boolean isResolvable(ConfigDataLocationResolverContext context,
                            ConfigDataLocation location)

Description copied from interface: ConfigDataLocationResolver

Returns if the specified location address can be resolved by this resolver.

Specified by:

isResolvable in interface ConfigDataLocationResolver<StandardConfigDataResource>

Parameters:

context - the location resolver context

location - the location to check.

Returns:

if the location is supported by this resolver

resolve

public List<StandardConfigDataResource> resolve(ConfigDataLocationResolverContext context,
                                                ConfigDataLocation location)
                                         throws ConfigDataNotFoundException

Description copied from interface: ConfigDataLocationResolver

Resolve a ConfigDataLocation into one or more ConfigDataResource instances.

Specified by:

resolve in interface ConfigDataLocationResolver<StandardConfigDataResource>

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

ConfigDataNotFoundException

resolveProfileSpecific

public List<StandardConfigDataResource> resolveProfileSpecific(ConfigDataLocationResolverContext context,
                                                               ConfigDataLocation location,
                                                               Profiles profiles)

Description copied from interface: ConfigDataLocationResolver

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.

Specified by:

resolveProfileSpecific in interface ConfigDataLocationResolver<StandardConfigDataResource>

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.