Annotation Type IndexAnnotated


  • @Documented
    @Retention(RUNTIME)
    @Target(ANNOTATION_TYPE)
    public @interface IndexAnnotated
    Index all classes annotated by annotation annotated by this meta-annotation.

    During compilation ClassIndexProcessor creates a resource file listing all classes annotated by annotation annotated by this meta-annotation.

    You can retrieve the list at runtime using ClassIndex.getAnnotated(Class). If the classes also have a zero-argument constructor you can use ServiceLoader facility.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean storeJavadoc
      Specifies whether to store Javadoc for runtime retrieval.
    • Element Detail

      • storeJavadoc

        boolean storeJavadoc
        Specifies whether to store Javadoc for runtime retrieval.

        You can retrieve the stored Javadoc summary using ClassIndex.getClassSummary(Class).

        Default:
        false