org.springframework.boot.autoconfigure.condition

Class ResourceCondition

java.lang.Object

org.springframework.boot.autoconfigure.condition.SpringBootCondition

org.springframework.boot.autoconfigure.condition.ResourceCondition

All Implemented Interfaces:

Condition

Direct Known Subclasses:

HazelcastConfigResourceCondition

public abstract class ResourceCondition
extends SpringBootCondition

SpringBootCondition used to check if a resource can be found using a configurable property and optional default location(s).

Since:

1.3.0

Author:

Stephane Nicoll, Phillip Webb

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourceCondition(String name, String prefix, String propertyName, String... resourceLocations) Create a new condition.

Method Summary

Modifier and Type	Method and Description
ConditionOutcome	getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) Determine the outcome of the match along with suitable log output.
protected ConditionOutcome	getResourceOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) Check if one of the default resource locations actually exists.
protected ConditionMessage.Builder	startConditionMessage()

Methods inherited from class org.springframework.boot.autoconfigure.condition.SpringBootCondition

anyMatches, matches, matches

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCondition

protected ResourceCondition(String name,
                            String prefix,
                            String propertyName,
                            String... resourceLocations)

Create a new condition.

Parameters:

name - the name of the component

prefix - the prefix of the configuration key

propertyName - the name of the configuration key

resourceLocations - default location(s) where the configuration file can be found if the configuration key is not specified

Method Detail

getMatchOutcome

public ConditionOutcome getMatchOutcome(ConditionContext context,
                                        AnnotatedTypeMetadata metadata)

Description copied from class: SpringBootCondition

Determine the outcome of the match along with suitable log output.

Specified by:

getMatchOutcome in class SpringBootCondition

Parameters:

context - the condition context

metadata - the annotation metadata

Returns:

the condition outcome

getResourceOutcome

protected ConditionOutcome getResourceOutcome(ConditionContext context,
                                              AnnotatedTypeMetadata metadata)

Check if one of the default resource locations actually exists.

Parameters:

context - the condition context

metadata - the annotation metadata

Returns:

the condition outcome

startConditionMessage

protected final ConditionMessage.Builder startConditionMessage()