Class SimpleElementVisitor6<R,P>

java.lang.Object
javax.lang.model.util.AbstractElementVisitor6<R,P>
javax.lang.model.util.SimpleElementVisitor6<R,P>
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 Implemented Interfaces:
ElementVisitor<R,P>
Direct Known Subclasses:
ElementKindVisitor6, SimpleElementVisitor7
@SupportedSourceVersion(RELEASE_6) public class SimpleElementVisitor6<R,P> extends AbstractElementVisitor6<R,P>
A simple visitor of program elements with default behavior appropriate for the RELEASE_6 source version. Visit methods corresponding to RELEASE_6 language constructs call defaultAction, passing their arguments to defaultAction's corresponding parameters. For constructs introduced in RELEASE_7 and later, visitUnknown is called instead.
API Note:
Methods in this class may be overridden subject to their general contract.

WARNING: The ElementVisitor interface implemented by this class may have methods added to it in the future to accommodate new, currently unknown, language structures added to future versions of the Java programming language. Therefore, methods whose names begin with "visit" may be added to this class in the future; to avoid incompatibilities, classes and subclasses which extend this class should not declare any instance methods with names beginning with "visit".

When such a new visit method is added, the default implementation in this class will be to directly or indirectly call the visitUnknown method. A new simple element visitor class will also be introduced to correspond to the new language level; this visitor will have different default behavior for the visit method in question. When a new visitor is introduced, portions of this visitor class may be deprecated, including its constructors.

Since:
1.6
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final R
    DEFAULT_VALUE
    Default value to be returned; defaultAction returns this value unless the method is overridden.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    SimpleElementVisitor6()
    Deprecated.
    Release 6 is obsolete; update to a visitor for a newer release level.
    protected
    SimpleElementVisitor6(R defaultValue)
    Deprecated.
    Release 6 is obsolete; update to a visitor for a newer release level.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected R
    defaultAction(Element e, P p)
    The default action for visit methods.
    R
    visitExecutable(ExecutableElement e, P p)
    Visits an executable element.
    R
    visitPackage(PackageElement e, P p)
    Visits a package element.
    R
    visitType(TypeElement e, P p)
    Visits a type element.
    R
    visitTypeParameter(TypeParameterElement e, P p)
    Visits a type parameter element.
    R
    visitVariable(VariableElement e, P p)
    Visits a variable element.

    Methods declared in class AbstractElementVisitor6

    visit, visit, visitModule, visitRecordComponent, visitUnknown
    Modifier and Type
    Method
    Description
    final R
    visit(Element e)
    Visits any program element as if by passing itself to that element's accept method and passing null for the additional parameter.
    final R
    visit(Element e, P p)
    Visits any program element as if by passing itself to that element's accept method.
    R
    visitModule(ModuleElement e, P p)
    Visits a module element.
    R
    visitRecordComponent(RecordComponentElement e, P p)
    Visits a record component element.
    R
    visitUnknown(Element e, P p)
    Visits an unknown kind of element.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Field Details

    • DEFAULT_VALUE

      protected final R DEFAULT_VALUE
      Default value to be returned; defaultAction returns this value unless the method is overridden.

  • Constructor Details

    • SimpleElementVisitor6

      @Deprecated(since="9") protected SimpleElementVisitor6()
      Deprecated.
      Release 6 is obsolete; update to a visitor for a newer release level.
      Constructor for concrete subclasses; uses null for the default value.

    • SimpleElementVisitor6

      @Deprecated(since="9") protected SimpleElementVisitor6(R defaultValue)
      Deprecated.
      Release 6 is obsolete; update to a visitor for a newer release level.
      Constructor for concrete subclasses; uses the argument for the default value.
      Parameters:
      defaultValue - the value to assign to DEFAULT_VALUE

  • Method Details

    • defaultAction

      protected R defaultAction(Element e, P p)
      The default action for visit methods.
      Implementation Requirements:
      The implementation in this class just returns DEFAULT_VALUE; subclasses will commonly override this method.
      Parameters:
      e - the element to process
      p - a visitor-specified parameter
      Returns:
      DEFAULT_VALUE unless overridden

    • visitPackage

      public R visitPackage(PackageElement e, P p)
      Visits a package element.
      Implementation Requirements:
      This implementation calls defaultAction.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      a visitor-specified result

    • visitType

      public R visitType(TypeElement e, P p)
      Visits a type element.
      Implementation Requirements:
      This implementation calls defaultAction.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      a visitor-specified result

    • visitVariable

      public R visitVariable(VariableElement e, P p)
      Visits a variable element.
      Implementation Requirements:
      This implementation calls defaultAction, unless the element is a RESOURCE_VARIABLE in which case visitUnknown is called.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      a visitor-specified result

    • visitExecutable

      public R visitExecutable(ExecutableElement e, P p)
      Visits an executable element.
      Implementation Requirements:
      This implementation calls defaultAction.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      a visitor-specified result

    • visitTypeParameter

      public R visitTypeParameter(TypeParameterElement e, P p)
      Visits a type parameter element.
      Implementation Requirements:
      This implementation calls defaultAction.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      a visitor-specified result