Record Class AnnotationQuery

java.lang.Object
java.lang.Record
dev.archunitjava.selector.AnnotationQuery
public record AnnotationQuery(JavaTypeName annotationType, AnnotationMatchMode mode, Optional<AnnotationVisibility> visibility, int maximumMetaDepth, UnknownHierarchyPolicy unknownPolicy) extends Record
Immutable annotation target, relationship, visibility, traversal bound, and unknown policy.

  • Constructor Details

    • AnnotationQuery

      public AnnotationQuery(JavaTypeName annotationType, AnnotationMatchMode mode, Optional<AnnotationVisibility> visibility, int maximumMetaDepth, UnknownHierarchyPolicy unknownPolicy)
      Creates an instance of a AnnotationQuery record class.
      Parameters:
      annotationType - the value for the annotationType record component
      mode - the value for the mode record component
      visibility - the value for the visibility record component
      maximumMetaDepth - the value for the maximumMetaDepth record component
      unknownPolicy - the value for the unknownPolicy record component

  • Method Details

    • direct

      public static AnnotationQuery direct(String annotationBinaryName)

    • metaAnnotated

      public static AnnotationQuery metaAnnotated(String annotationBinaryName)

    • inherited

      public static AnnotationQuery inherited(String annotationBinaryName)

    • typeUse

      public static AnnotationQuery typeUse(String annotationBinaryName)

    • withVisibility

      public AnnotationQuery withVisibility(AnnotationVisibility value)

    • withMaximumMetaDepth

      public AnnotationQuery withMaximumMetaDepth(int value)

    • withUnknownPolicy

      public AnnotationQuery withUnknownPolicy(UnknownHierarchyPolicy value)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • annotationType

      public JavaTypeName annotationType()
      Returns the value of the annotationType record component.
      Returns:
      the value of the annotationType record component

    • mode

      public AnnotationMatchMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • visibility

      public Optional<AnnotationVisibility> visibility()
      Returns the value of the visibility record component.
      Returns:
      the value of the visibility record component

    • maximumMetaDepth

      public int maximumMetaDepth()
      Returns the value of the maximumMetaDepth record component.
      Returns:
      the value of the maximumMetaDepth record component

    • unknownPolicy

      public UnknownHierarchyPolicy unknownPolicy()
      Returns the value of the unknownPolicy record component.
      Returns:
      the value of the unknownPolicy record component