Package org.springframework.boot.autoconfigure.condition

Class ConditionEvaluationReport

java.lang.Object

org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport

public final class ConditionEvaluationReport
extends Object

Records condition evaluation details for reporting and logging.

Since:

1.0.0

Author:

Greg Turnquist, Dave Syer, Phillip Webb, Andy Wilkinson, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConditionEvaluationReport.ConditionAndOutcome	Provides access to a single Condition and ConditionOutcome.
static class	ConditionEvaluationReport.ConditionAndOutcomes	Provides access to a number of ConditionEvaluationReport.ConditionAndOutcome items.

Method Summary

Modifier and Type	Method	Description
static ConditionEvaluationReport	find(BeanFactory beanFactory)	Attempt to find the ConditionEvaluationReport for the specified bean factory.
static ConditionEvaluationReport	get(ConfigurableListableBeanFactory beanFactory)	Obtain a ConditionEvaluationReport for the specified bean factory.
Map<String,ConditionEvaluationReport.ConditionAndOutcomes>	getConditionAndOutcomesBySource()	Returns condition outcomes from this report, grouped by the source.
ConditionEvaluationReport	getDelta(ConditionEvaluationReport previousReport)
List<String>	getExclusions()	Returns the names of the classes that have been excluded from condition evaluation.
ConditionEvaluationReport	getParent()	The parent report (from a parent BeanFactory if there is one).
Set<String>	getUnconditionalClasses()	Returns the names of the classes that were evaluated but were not conditional.
void	recordConditionEvaluation(String source, Condition condition, ConditionOutcome outcome)	Record the occurrence of condition evaluation.
void	recordEvaluationCandidates(List<String> evaluationCandidates)	Records the names of the classes that are candidates for condition evaluation.
void	recordExclusions(Collection<String> exclusions)	Records the names of the classes that have been excluded from condition evaluation.

Methods inherited from class java.lang.Object

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

Method Details

recordConditionEvaluation

public void recordConditionEvaluation(String source,
 Condition condition,
 ConditionOutcome outcome)

Record the occurrence of condition evaluation.

Parameters:

source - the source of the condition (class or method name)

condition - the condition evaluated

outcome - the condition outcome

recordExclusions

public void recordExclusions(Collection<String> exclusions)

Records the names of the classes that have been excluded from condition evaluation.

Parameters:

exclusions - the names of the excluded classes

recordEvaluationCandidates

public void recordEvaluationCandidates(List<String> evaluationCandidates)

Records the names of the classes that are candidates for condition evaluation.

Parameters:

evaluationCandidates - the names of the classes whose conditions will be evaluated

getConditionAndOutcomesBySource

public Map<String,ConditionEvaluationReport.ConditionAndOutcomes> getConditionAndOutcomesBySource()

Returns condition outcomes from this report, grouped by the source.

Returns:

the condition outcomes

getExclusions

public List<String> getExclusions()

Returns the names of the classes that have been excluded from condition evaluation.

Returns:

the names of the excluded classes

getUnconditionalClasses

public Set<String> getUnconditionalClasses()

Returns the names of the classes that were evaluated but were not conditional.

Returns:

the names of the unconditional classes

getParent

public ConditionEvaluationReport getParent()

The parent report (from a parent BeanFactory if there is one).

Returns:

the parent report (or null if there isn't one)

find

public static ConditionEvaluationReport find(BeanFactory beanFactory)

Attempt to find the ConditionEvaluationReport for the specified bean factory.

Parameters:

beanFactory - the bean factory (may be null)

Returns:

the ConditionEvaluationReport or null

get

public static ConditionEvaluationReport get(ConfigurableListableBeanFactory beanFactory)

Obtain a ConditionEvaluationReport for the specified bean factory.

Parameters:

beanFactory - the bean factory

Returns:

an existing or new ConditionEvaluationReport

getDelta

public ConditionEvaluationReport getDelta(ConditionEvaluationReport previousReport)