Package com.tngtech.archunit.lang

Interface ArchCondition.ConditionByPredicate.EventDescriber

Enclosing class:

ArchCondition.ConditionByPredicate<T extends HasDescription & HasSourceCodeLocation>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@PublicAPI(usage=INHERITANCE)
public static interface ArchCondition.ConditionByPredicate.EventDescriber

Defines how to describe a single ConditionEvent. E.g. how to describe the concrete violation of some class com.Example that violates the ArchCondition.ConditionByPredicate.

Method Summary

Modifier and Type	Method	Description
String	describe(String predicateDescription, boolean satisfied)	Describes a ConditionEvent created by ConditionByPredicate, given the description of the defining predicate and whether the predicate was satisfied. For example, if the defining DescribedPredicate would be JavaClass.Predicates.simpleName(String), then the created description could be (satisfied ? "has " : "does not have ") + predicateDescription.

Method Details

describe

String describe(String predicateDescription,
 boolean satisfied)

Describes a ConditionEvent created by ConditionByPredicate, given the description of the defining predicate and whether the predicate was satisfied.
For example, if the defining DescribedPredicate would be JavaClass.Predicates.simpleName(String), then the created description could be (satisfied ? "has " : "does not have ") + predicateDescription.

Parameters:

predicateDescription - The description of the DescribedPredicate defining the ConditionByPredicate

satisfied - Whether the object tested by the ConditionByPredicate satisfied the condition

Returns:

The description of the ConditionEvent to be created