Record Class AnnotationSite

java.lang.Object

java.lang.Record

dev.archunitjava.model.AnnotationSite

public record AnnotationSite(AnnotationSiteKind kind, String ownerKey, OptionalInt parameterIndex, Optional<JavaTypeUseTarget> typeUseTarget)
extends Record

Exact owner and sub-location of an annotation occurrence.

Constructor Summary

Constructors

Constructor	Description
AnnotationSite(AnnotationSiteKind kind, String ownerKey, OptionalInt parameterIndex, Optional<JavaTypeUseTarget> typeUseTarget)	Creates an instance of a AnnotationSite record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
AnnotationSiteKind	kind()	Returns the value of the kind record component.
String	ownerKey()	Returns the value of the ownerKey record component.
OptionalInt	parameterIndex()	Returns the value of the parameterIndex record component.
String	stableKey()
final String	toString()	Returns a string representation of this record class.
Optional<JavaTypeUseTarget>	typeUseTarget()	Returns the value of the typeUseTarget record component.

Methods inherited from class Object

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

Constructor Details

AnnotationSite

public AnnotationSite(AnnotationSiteKind kind,
 String ownerKey,
 OptionalInt parameterIndex,
 Optional<JavaTypeUseTarget> typeUseTarget)

Creates an instance of a AnnotationSite record class.

Parameters:

kind - the value for the kind record component

ownerKey - the value for the ownerKey record component

parameterIndex - the value for the parameterIndex record component

typeUseTarget - the value for the typeUseTarget record component

Method Details

stableKey

public String stableKey()

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.

kind

public AnnotationSiteKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

ownerKey

public String ownerKey()

Returns the value of the ownerKey record component.

Returns:

the value of the ownerKey record component

parameterIndex

public OptionalInt parameterIndex()

Returns the value of the parameterIndex record component.

Returns:

the value of the parameterIndex record component

typeUseTarget

public Optional<JavaTypeUseTarget> typeUseTarget()

Returns the value of the typeUseTarget record component.

Returns:

the value of the typeUseTarget record component