Package com.tngtech.archunit.lang
Class SimpleConditionEvent
java.lang.Object
com.tngtech.archunit.lang.SimpleConditionEvent
- All Implemented Interfaces:
ConditionEvent
@PublicAPI(usage=ACCESS) public final class SimpleConditionEvent extends java.lang.Object implements ConditionEvent
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.tngtech.archunit.lang.ConditionEvent
ConditionEvent.Handler
-
Constructor Summary
Constructors Constructor Description SimpleConditionEvent(java.lang.Object correspondingObject, boolean conditionSatisfied, java.lang.String message)
-
Method Summary
Modifier and Type Method Description void
addInvertedTo(ConditionEvents events)
Adds the 'opposite' of the event.java.util.List<java.lang.String>
getDescriptionLines()
void
handleWith(ConditionEvent.Handler handler)
Supplies the corresponding objects and description to the supplied handler.boolean
isViolation()
static ConditionEvent
satisfied(java.lang.Object correspondingObject, java.lang.String message)
java.lang.String
toString()
static ConditionEvent
violated(java.lang.Object correspondingObject, java.lang.String message)
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
SimpleConditionEvent
public SimpleConditionEvent(java.lang.Object correspondingObject, boolean conditionSatisfied, java.lang.String message)
-
-
Method Details
-
isViolation
public boolean isViolation()- Specified by:
isViolation
in interfaceConditionEvent
- Returns:
true
if this event represents a violation of an evaluated rule,false
otherwise
-
addInvertedTo
Description copied from interface:ConditionEvent
Adds the 'opposite' of the event.
E.g. The event is a violation, if some conditions A and B are both true?
-> The 'inverted' event is a violation if either A or B (or both) are not true
In the most simple case, this is just an equivalent event evaluatingConditionEvent.isViolation()
inverted.- Specified by:
addInvertedTo
in interfaceConditionEvent
- Parameters:
events
- The events to add the 'inverted self' to
-
getDescriptionLines
public java.util.List<java.lang.String> getDescriptionLines()- Specified by:
getDescriptionLines
in interfaceConditionEvent
- Returns:
- A textual description of this event as a list of lines
-
handleWith
Description copied from interface:ConditionEvent
Supplies the corresponding objects and description to the supplied handler.
The term "corresponding objects" refers to the objects involved in the evaluation of this rule. E.g. the rule checks for illegal field accesses, then this object might be a single field access checked by the rule.
May also be a collection of objects, if the evaluation of the rule depends on sets of objects. E.g. the rule checks that some access to another class happened? The rule can only be violated, by a whole set (all accesses from a class) of objects, but not by a single one (if there is more than one).- Specified by:
handleWith
in interfaceConditionEvent
- Parameters:
handler
- The handler to supply the data of this event to.
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
violated
public static ConditionEvent violated(java.lang.Object correspondingObject, java.lang.String message) -
satisfied
public static ConditionEvent satisfied(java.lang.Object correspondingObject, java.lang.String message)
-