Record Class AnnotationValueCondition

java.lang.Object

java.lang.Record

dev.archunitjava.rules.AnnotationValueCondition

All Implemented Interfaces:

Comparable<AnnotationValueCondition>

public record AnnotationValueCondition(String elementName, AnnotationValueOperator operator, Optional<JavaAnnotationValue> expectedValue)
extends Record
implements Comparable<AnnotationValueCondition>

One typed condition over an explicitly encoded annotation element.

Constructor Summary

Constructors

Constructor	Description
AnnotationValueCondition(String elementName, AnnotationValueOperator operator, Optional<JavaAnnotationValue> expectedValue)	Creates an instance of a AnnotationValueCondition record class.

Method Summary

Modifier and Type	Method	Description
static AnnotationValueCondition	absent(String elementName)
int	compareTo(AnnotationValueCondition other)
String	elementName()	Returns the value of the elementName record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static AnnotationValueCondition	equalTo(String elementName, JavaAnnotationValue value)
Optional<JavaAnnotationValue>	expectedValue()	Returns the value of the expectedValue record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	matches(JavaAnnotation annotation)
static AnnotationValueCondition	notEqualTo(String elementName, JavaAnnotationValue value)
AnnotationValueOperator	operator()	Returns the value of the operator record component.
static AnnotationValueCondition	present(String elementName)
String	stableKey()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AnnotationValueCondition

public AnnotationValueCondition(String elementName,
 AnnotationValueOperator operator,
 Optional<JavaAnnotationValue> expectedValue)

Creates an instance of a AnnotationValueCondition record class.

Parameters:

elementName - the value for the elementName record component

operator - the value for the operator record component

expectedValue - the value for the expectedValue record component

Method Details

present

public static AnnotationValueCondition present(String elementName)

absent

public static AnnotationValueCondition absent(String elementName)

equalTo

public static AnnotationValueCondition equalTo(String elementName,
 JavaAnnotationValue value)

notEqualTo

public static AnnotationValueCondition notEqualTo(String elementName,
 JavaAnnotationValue value)

matches

public boolean matches(JavaAnnotation annotation)

stableKey

public String stableKey()

compareTo

public int compareTo(AnnotationValueCondition other)

Specified by:

compareTo in interface Comparable<AnnotationValueCondition>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

elementName

public String elementName()

Returns the value of the elementName record component.

Returns:

the value of the elementName record component

operator

public AnnotationValueOperator operator()

Returns the value of the operator record component.

Returns:

the value of the operator record component

expectedValue

public Optional<JavaAnnotationValue> expectedValue()

Returns the value of the expectedValue record component.

Returns:

the value of the expectedValue record component