Module jakarta.cdi
Package jakarta.enterprise.inject.spi

Interface Annotated

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T extends java.lang.annotation.Annotation>
      T      		 getAnnotation​(java.lang.Class<T> annotationType)
      Get program element annotation of a certain annotation type.
      java.util.Set<java.lang.annotation.Annotation> getAnnotations()
      Get all annotations of the program element.
      <T extends java.lang.annotation.Annotation>
      java.util.Set<T>      		 getAnnotations​(java.lang.Class<T> annotationType)
      Get program element annotations of a certain annotation type.
      java.lang.reflect.Type getBaseType()
      Get the type of the annotated program element.
      java.util.Set<java.lang.reflect.Type> getTypeClosure()
      Get all types to which the base type should be considered assignable.
      boolean isAnnotationPresent​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
      Determine if the program element has an annotation of a certain annotation type.

    • Method Detail

      • getBaseType

        java.lang.reflect.Type getBaseType()

        Get the type of the annotated program element.

        Returns:
        the type of the annotated program element

      • getTypeClosure

        java.util.Set<java.lang.reflect.Type> getTypeClosure()

        Get all types to which the base type should be considered assignable.

        Returns:
        a set of all types to which the base type should be considered assignable

      • getAnnotation

        <T extends java.lang.annotation.Annotation> T getAnnotation​(java.lang.Class<T> annotationType)

        Get program element annotation of a certain annotation type. The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotation(Class), where repeatable annotations are not supported.

        Type Parameters:
        T - the type of the annotation
        Parameters:
        annotationType - the class of the annotation type
        Returns:
        the first program element annotation of the given annotation type, or a null value

      • getAnnotations

        <T extends java.lang.annotation.Annotation> java.util.Set<T> getAnnotations​(java.lang.Class<T> annotationType)

        Get program element annotations of a certain annotation type.

        This method returns back all annotations, including repeatable annotations of this type. The behavior of this method is intended to be the same behavior as AnnotatedElement.getAnnotationsByType(Class), where repeatable annotations are supported.

        Type Parameters:
        T - the type of the annotation
        Parameters:
        annotationType - the class of the annotation type
        Returns:
        the program element annotations of the given annotation type, or an empty collection

      • getAnnotations

        java.util.Set<java.lang.annotation.Annotation> getAnnotations()

        Get all annotations of the program element.

        Returns:
        all annotations of the program element, or an empty set if no annotations are present

      • isAnnotationPresent

        boolean isAnnotationPresent​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

        Determine if the program element has an annotation of a certain annotation type. The behavior of this method is similar to AnnotatedElement.isAnnotationPresent(Class) for the underlying program element.

        Parameters:
        annotationType - the annotation type to check for
        Returns:
        true if the program element has an annotation of the given annotation type, or false otherwise