javax.annotation.processing

Class AbstractProcessor

Inhoudsopgave
  • All Implemented Interfaces:
    Processor

    public abstract class AbstractProcessor
extends Object
implements Processor
    An abstract annotation processor designed to be a convenient superclass for most concrete annotation processors. This class examines annotation values to compute the options, annotations, and source version supported by its subtypes.

    The getter methods may issue warnings about noteworthy conditions using the facilities available after the processor has been initialized.

    Subclasses are free to override the implementation and specification of any of the methods in this class as long as the general Processor contract for that method is obeyed.

    Since:
    1.6

    • Field Detail

      • processingEnv

        protected ProcessingEnvironment processingEnv
        Processing environment providing by the tool framework.

    • Constructor Detail

      • AbstractProcessor

        protected AbstractProcessor()
        Constructor for subclasses to call.

    • Method Detail

      • getSupportedOptions

        public Set<String> getSupportedOptions()
        If the processor class is annotated with SupportedOptions, return an unmodifiable set with the same set of strings as the annotation. If the class is not so annotated, an empty set is returned.
        Specified by:
        getSupportedOptions in interface Processor
        Returns:
        the options recognized by this processor, or an empty set if none
        See Also:
        SupportedOptions

      • getSupportedAnnotationTypes

        public Set<String> getSupportedAnnotationTypes()
        If the processor class is annotated with SupportedAnnotationTypes, return an unmodifiable set with the same set of strings as the annotation. If the class is not so annotated, an empty set is returned.
        Specified by:
        getSupportedAnnotationTypes in interface Processor
        Returns:
        the names of the annotation types supported by this processor, or an empty set if none
        See Also:
        SupportedAnnotationTypes

      • init

        public void init(ProcessingEnvironment processingEnv)
        Initializes the processor with the processing environment by setting the processingEnv field to the value of the processingEnv argument. An IllegalStateException will be thrown if this method is called more than once on the same object.
        Specified by:
        init in interface Processor
        Parameters:
        processingEnv - environment to access facilities the tool framework provides to the processor
        Throws:
        IllegalStateException - if this method is called more than once.

      • process

        public abstract boolean process(Set<? extends TypeElement> annotations,
              RoundEnvironment roundEnv)
        Processes a set of annotation types on type elements originating from the prior round and returns whether or not these annotations are claimed by this processor. If true is returned, the annotations are claimed and subsequent processors will not be asked to process them; if false is returned, the annotations are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on chosen criteria.

        The input set will be empty if the processor supports "*" and the root elements have no annotations. A Processor must gracefully handle an empty set of annotations.

        Specified by:
        process in interface Processor
        Parameters:
        annotations - the annotation types requested to be processed
        roundEnv - environment for information about the current and prior round
        Returns:
        whether or not the set of annotations are claimed by this processor

      • getCompletions

        public Iterable<? extends Completion> getCompletions(Element element,
                                            AnnotationMirror annotation,
                                            ExecutableElement member,
                                            String userText)
        Returns an empty iterable of completions.
        Specified by:
        getCompletions in interface Processor
        Parameters:
        element - the element being annotated
        annotation - the (perhaps partial) annotation being applied to the element
        member - the annotation member to return possible completions for
        userText - source code text to be completed
        Returns:
        suggested completions to the annotation

      • isInitialized

        protected boolean isInitialized()
        Returns true if this object has been initialized, false otherwise.
        Returns:
        true if this object has been initialized, false otherwise.

Nederlandse vertaling

U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.

Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.

Bij voorbaat dank.

Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/annotation/processing/AbstractProcessor.html

De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.

Referenties

  1. Bekijk - html-document Taal van het document:fr Manuel PHP : https://docs.oracle.com

Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.

Inhoudsopgave Haut