javax.lang.model.element

Interface ElementVisitor<R,P>

Contents
  • Type Parameters:
    R - the return type of this visitor's methods. Use Void for visitors that do not need to return results.
    P - the type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.
    All Known Implementing Classes:
    AbstractElementVisitor6, AbstractElementVisitor7, ElementKindVisitor6, ElementKindVisitor7, ElementScanner6, ElementScanner7, SimpleElementVisitor6, SimpleElementVisitor7

    public interface ElementVisitor<R,P>
    A visitor of program elements, in the style of the visitor design pattern. Classes implementing this interface are used to operate on an element when the kind of element is unknown at compile time. When a visitor is passed to an element's accept method, the visitXYZ method most applicable to that element is invoked.

    Classes implementing this interface may or may not throw a NullPointerException if the additional parameter p is null; see documentation of the implementing class for details.

    WARNING: It is possible that methods will be added to this interface to accommodate new, currently unknown, language structures added to future versions of the Java™ programming language. Therefore, visitor classes directly implementing this interface may be source incompatible with future versions of the platform. To avoid this source incompatibility, visitor implementations are encouraged to instead extend the appropriate abstract visitor class that implements this interface. However, an API should generally use this visitor interface as the type for parameters, return type, etc. rather than one of the abstract classes.

    Since:
    1.6
    See Also:
    AbstractElementVisitor6, AbstractElementVisitor7

    • Method Detail

      • visit

        R visit(Element e,
      P p)
        Visits an element.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result

      • visit

        R visit(Element e)
        A convenience method equivalent to v.visit(e, null).
        Parameters:
        e - the element to visit
        Returns:
        a visitor-specified result

      • visitPackage

        R visitPackage(PackageElement e,
             P p)
        Visits a package element.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result

      • visitType

        R visitType(TypeElement e,
          P p)
        Visits a type element.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result

      • visitVariable

        R visitVariable(VariableElement e,
              P p)
        Visits a variable element.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result

      • visitExecutable

        R visitExecutable(ExecutableElement e,
                P p)
        Visits an executable element.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result

      • visitTypeParameter

        R visitTypeParameter(TypeParameterElement e,
                   P p)
        Visits a type parameter element.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result

      • visitUnknown

        R visitUnknown(Element e,
             P p)
        Visits an unknown kind of element. This can occur if the language evolves and new kinds of elements are added to the Element hierarchy.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        a visitor-specified result
        Throws:
        UnknownElementException - a visitor implementation may optionally throw this exception

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/lang/model/element/ElementVisitor.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut