Interface BasicAnnotationProcessor.Step

  • All Known Implementing Classes:
    BasicAnnotationProcessor.ProcessingStepAsStep
    Enclosing class:
    BasicAnnotationProcessor

    public static interface BasicAnnotationProcessor.Step
    The unit of processing logic that runs under the guarantee that all elements are complete and well-formed. A step may reject elements that are not ready for processing but may be at a later round.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Set<java.lang.String> annotations()
      The set of fully-qualified annotation type names processed by this step.
      java.util.Set<? extends javax.lang.model.element.Element> process​(com.google.common.collect.ImmutableSetMultimap<java.lang.String,​javax.lang.model.element.Element> elementsByAnnotation)
      The implementation of processing logic for the step.
    • Method Detail

      • annotations

        java.util.Set<java.lang.String> annotations()
        The set of fully-qualified annotation type names processed by this step.

        Warning: If the returned names are not names of annotations, they'll be ignored.

      • process

        java.util.Set<? extends javax.lang.model.element.Element> process​(com.google.common.collect.ImmutableSetMultimap<java.lang.String,​javax.lang.model.element.Element> elementsByAnnotation)
        The implementation of processing logic for the step. It is guaranteed that the keys in elementsByAnnotation will be a subset of the set returned by annotations().
        Returns:
        the elements (a subset of the values of elementsByAnnotation) that this step is unable to process, possibly until a later processing round. These elements will be passed back to this step at the next round of processing.