Record Class AnnotationRuleSpec

java.lang.Object

java.lang.Record

dev.archunitjava.rules.AnnotationRuleSpec

public record AnnotationRuleSpec(AnnotationQuery query, AnnotationRuleMode mode, List<AnnotationValueCondition> valueConditions, UnknownAnnotationPolicy unknownAnnotations)
extends Record

Immutable annotation relationship, mood, typed values, and traversal-gap policy.

Constructor Summary

Constructors

Constructor	Description
AnnotationRuleSpec(AnnotationQuery query, AnnotationRuleMode mode, List<AnnotationValueCondition> valueConditions, UnknownAnnotationPolicy unknownAnnotations)	Creates an instance of a AnnotationRuleSpec record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static AnnotationRuleSpec	forbid(AnnotationQuery query)
final int	hashCode()	Returns a hash code value for this object.
AnnotationRuleMode	mode()	Returns the value of the mode record component.
AnnotationQuery	query()	Returns the value of the query record component.
static AnnotationRuleSpec	require(AnnotationQuery query)
String	semanticKey()
final String	toString()	Returns a string representation of this record class.
UnknownAnnotationPolicy	unknownAnnotations()	Returns the value of the unknownAnnotations record component.
List<AnnotationValueCondition>	valueConditions()	Returns the value of the valueConditions record component.
AnnotationRuleSpec	withUnknownAnnotations(UnknownAnnotationPolicy value)
AnnotationRuleSpec	withValueCondition(AnnotationValueCondition condition)

Methods inherited from class Object

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

Constructor Details

AnnotationRuleSpec

public AnnotationRuleSpec(AnnotationQuery query,
 AnnotationRuleMode mode,
 List<AnnotationValueCondition> valueConditions,
 UnknownAnnotationPolicy unknownAnnotations)

Creates an instance of a AnnotationRuleSpec record class.

Parameters:

query - the value for the query record component

mode - the value for the mode record component

valueConditions - the value for the valueConditions record component

unknownAnnotations - the value for the unknownAnnotations record component

Method Details

require

public static AnnotationRuleSpec require(AnnotationQuery query)

forbid

public static AnnotationRuleSpec forbid(AnnotationQuery query)

withValueCondition

public AnnotationRuleSpec withValueCondition(AnnotationValueCondition condition)

withUnknownAnnotations

public AnnotationRuleSpec withUnknownAnnotations(UnknownAnnotationPolicy value)

semanticKey

public String semanticKey()

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.

query

public AnnotationQuery query()

Returns the value of the query record component.

Returns:

the value of the query record component

mode

public AnnotationRuleMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

valueConditions

public List<AnnotationValueCondition> valueConditions()

Returns the value of the valueConditions record component.

Returns:

the value of the valueConditions record component

unknownAnnotations

public UnknownAnnotationPolicy unknownAnnotations()

Returns the value of the unknownAnnotations record component.

Returns:

the value of the unknownAnnotations record component