Module java.compiler
Package javax.lang.model.util

Class ElementScanner14<R,​P>

java.lang.Object
javax.lang.model.util.AbstractElementVisitor6<R,​P>
javax.lang.model.util.ElementScanner6<R,​P>
javax.lang.model.util.ElementScanner7<R,​P>
javax.lang.model.util.ElementScanner8<R,​P>
javax.lang.model.util.ElementScanner9<R,​P>
javax.lang.model.util.ElementScanner14<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>
@SupportedSourceVersion(RELEASE_14)
public class ElementScanner14<R,​P>
extends ElementScanner9<R,​P>
This class is associated with records, a preview feature of the Java language. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.

A scanning visitor of program elements with default behavior appropriate for the RELEASE_14 source version. The visitXyz methods in this class scan their component elements by calling scan on their enclosed elements, parameters, etc., as indicated in the individual method specifications. A subclass can control the order elements are visited by overriding the visitXyz methods. Note that clients of a scanner may get the desired behavior be invoking v.scan(e, p) rather than v.visit(e, p) on the root objects of interest.

When a subclass overrides a visitXyz method, the new method can cause the enclosed elements to be scanned in the default way by calling super.visitXyz. In this fashion, the concrete visitor can control the ordering of traversal over the component elements with respect to the additional processing; for example, consistently calling super.visitXyz at the start of the overridden methods will yield a preorder traversal, etc. If the component elements should be traversed in some other order, instead of calling super.visitXyz, an overriding visit method should call scan with the elements in the desired order.

Methods in this class may be overridden subject to their general contract. Note that annotating methods in concrete subclasses with @Override will help ensure that methods are overridden as intended.

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 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 call the visitUnknown method. A new element scanner 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 the new visitor is introduced, all or portions of this visitor may be deprecated.

Since:
14
See Also:
ElementScanner6, ElementScanner7, ElementScanner8, ElementScanner9

  • Constructor Details

    • ElementScanner14

      protected ElementScanner14()
      Constructor for concrete subclasses; uses null for the default value.

    • ElementScanner14

      protected ElementScanner14​(R defaultValue)
      Constructor for concrete subclasses; uses the argument for the default value.
      Parameters:
      defaultValue - the default value

  • Method Details

    • visitType

      public R visitType​(TypeElement e, P p)
      Visits a type element.
      Specified by:
      visitType in interface ElementVisitor<R,​P>
      Overrides:
      visitType in class ElementScanner6<R,​P>
      Implementation Requirements:
      This implementation scans the type parameters, if any, and then the enclosed elements.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      the result of scanning

    • visitExecutable

      public R visitExecutable​(ExecutableElement e, P p)
      Visits an executable element.
      Specified by:
      visitExecutable in interface ElementVisitor<R,​P>
      Overrides:
      visitExecutable in class ElementScanner6<R,​P>
      Implementation Requirements:
      This implementation first scans the type parameters, if any, and then the parameters.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      the result of scanning

    • visitRecordComponent

      public R visitRecordComponent​(RecordComponentElement e, P p)
      This method is associated with records, a preview feature of the Java language. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.

      Visits a record component element.
      Specified by:
      visitRecordComponent in interface ElementVisitor<R,​P>
      Overrides:
      visitRecordComponent in class AbstractElementVisitor6<R,​P>
      Implementation Requirements:
      This implementation scans the enclosed elements.
      Parameters:
      e - the element to visit
      p - a visitor-specified parameter
      Returns:
      the result of the scan