Package org.jboss.jandex

Class MutableAnnotationOverlay.Builder

java.lang.Object
org.jboss.jandex.MutableAnnotationOverlay.Builder
Enclosing interface:
MutableAnnotationOverlay
public static final class MutableAnnotationOverlay.Builder extends Object
The builder for a mutable annotation overlay.

  • Method Details

    • compatibleMode

      public MutableAnnotationOverlay.Builder compatibleMode()
      When called, the built annotation overlay shall treat method parameters as part of methods. This means that annotations on method parameters are returned when asking for annotations of a method, asking for annotations on method parameters results in an exception, and annotation transformations for methods are produced when adding/removing annotations to/from a method parameter.

      This method is called compatibleMode because the built annotation overlay is compatible with the previous implementation of the same concept in Quarkus.

      Returns:
      this builder

    • runtimeAnnotationsOnly

      public MutableAnnotationOverlay.Builder runtimeAnnotationsOnly()
      When called, the built annotation overlay shall only return runtime-retained annotations; class-retained annotations are ignored. Note that this only applies to annotations present in class files (and therefore in Jandex); annotations added to the overlay using MutableAnnotationOverlay.addAnnotation(Declaration, AnnotationInstance) are not inspected and are always returned.
      Returns:
      this builder

    • inheritedAnnotations

      public MutableAnnotationOverlay.Builder inheritedAnnotations()
      When called, the built annotation overlay shall return inherited annotations per the Java rules.
      Returns:
      this builder

    • build

      public MutableAnnotationOverlay build()
      Builds and returns a mutable annotation overlay based on the configuration of this builder.
      Returns:
      the mutable annotation overlay, never null