Class AnnotationOverlay.Builder

java.lang.Object
org.jboss.jandex.AnnotationOverlay.Builder
Enclosing interface:
AnnotationOverlay

public static final class AnnotationOverlay.Builder extends Object
The builder for an annotation overlay.
  • Field Details

    • index

      private final IndexView index
    • annotationTransformations

      private final Collection<AnnotationTransformation> annotationTransformations
    • compatibleMode

      private boolean compatibleMode
    • runtimeAnnotationsOnly

      private boolean runtimeAnnotationsOnly
    • inheritedAnnotations

      private boolean inheritedAnnotations
  • Constructor Details

  • Method Details

    • compatibleMode

      public AnnotationOverlay.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 method parameters are ignored.

      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 AnnotationOverlay.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 annotation transformations are not inspected and are always returned.
      Returns:
      this builder
    • inheritedAnnotations

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

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