org.springframework.boot.autoconfigure.condition

Class OnPropertyListCondition

java.lang.Object

org.springframework.boot.autoconfigure.condition.SpringBootCondition

org.springframework.boot.autoconfigure.condition.OnPropertyListCondition

All Implemented Interfaces:

Condition

public class OnPropertyListCondition
extends SpringBootCondition

Condition that checks if a property whose value is a list is defined in the environment.

Since:

2.0.5

Author:

Eneias Silva, Stephane Nicoll

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OnPropertyListCondition(String propertyName, Supplier<ConditionMessage.Builder> messageBuilder) Create a new instance with the property to check and the message builder to use.

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.

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

anyMatches, logOutcome, matches, matches

Methods inherited from class java.lang.Object

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

Constructor Detail

OnPropertyListCondition

protected OnPropertyListCondition(String propertyName,
                                  Supplier<ConditionMessage.Builder> messageBuilder)

Create a new instance with the property to check and the message builder to use.

Parameters:

propertyName - the name of the property

messageBuilder - a message builder supplier that should provide a fresh instance on each call

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