Top Description Constructors Methods
javax.lang.model.util

public Class ElementScanner14<R, P>

extends ElementScanner9<R, P>
Class Inheritance
Known Direct Subclasses
javax.lang.model.util.ElementScannerPreview
Annotations
@SupportedSourceVersion:RELEASE_23
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.
Imports
java.util.List, .ArrayList, javax.lang.model.element.*, .ElementVisitor, javax.annotation.processing.SupportedSourceVersion, javax.lang.model.SourceVersion

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 by 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.

API Note

Methods in this class may be overridden subject to their general contract.

Since
16
See Also
<strong>Compatibility note for subclasses</strong>, ElementScanner6, ElementScanner7, ElementScanner8, ElementScanner9

Constructor Summary

AccessConstructor and Description
protected
ElementScanner14()

Constructor for concrete subclasses; uses null for the default value.

protected
ElementScanner14(R
the default value
defaultValue
)

Constructor for concrete subclasses; uses the argument for the default value.

Method Summary

Modifier and TypeMethod and Description
private List<? extends Element>
createScanningList(Parameterizable element, List<? extends Element> toBeScanned)

public R

Returns:

the result of scanning
visitExecutable
(ExecutableElement
the element to visit
e
,
P
a visitor-specified parameter
p
)

Overrides javax.lang.model.util.ElementScanner6.visitExecutable.

Implements javax.lang.model.element.ElementVisitor.visitExecutable.

Visits an executable element.

public R

Returns:

the result of scanning
visitRecordComponent
(RecordComponentElement
the element to visit
e
,
P
a visitor-specified parameter
p
)

Overrides javax.lang.model.util.ElementScanner6.visitRecordComponent.

Overrides default javax.lang.model.element.ElementVisitor.visitRecordComponent.

Visits a record component element.

public R

Returns:

the result of scanning
visitType
(TypeElement
the element to visit
e
,
P
a visitor-specified parameter
p
)

Overrides javax.lang.model.util.ElementScanner6.visitType.

Implements javax.lang.model.element.ElementVisitor.visitType.

Visits a type element.

Inherited from javax.lang.model.util.ElementScanner9:
visitModule

Constructor Detail

ElementScanner14back to summary
protected ElementScanner14()

Constructor for concrete subclasses; uses null for the default value.

ElementScanner14back to summary
protected ElementScanner14(R defaultValue)

Constructor for concrete subclasses; uses the argument for the default value.

Parameters
defaultValue:R

the default value

Method Detail

createScanningListback to summary
private List<? extends Element> createScanningList(Parameterizable element, List<? extends Element> toBeScanned)
visitExecutableback to summary
public R visitExecutable(ExecutableElement e, P p)

Overrides javax.lang.model.util.ElementScanner6.visitExecutable.

Implements javax.lang.model.element.ElementVisitor.visitExecutable.

Doc from javax.lang.model.element.ElementVisitor.visitExecutable.

Visits an executable element.

Implementation Specification

This implementation first scans the type parameters, if any, and then the parameters.

Parameters
e:ExecutableElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

Doc from javax.lang.model.util.ElementScanner6.visitExecutable.

the result of scanning

Annotations
@Override
visitRecordComponentback to summary
public R visitRecordComponent(RecordComponentElement e, P p)

Overrides javax.lang.model.util.ElementScanner6.visitRecordComponent.

Overrides default javax.lang.model.element.ElementVisitor.visitRecordComponent.

Doc from javax.lang.model.element.ElementVisitor.visitRecordComponent.

Visits a record component element.

Implementation Specification

This implementation scans the enclosed elements.

Parameters
e:RecordComponentElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

Doc from javax.lang.model.util.ElementScanner6.visitRecordComponent.

the result of scanning

Annotations
@Override
visitTypeback to summary
public R visitType(TypeElement e, P p)

Overrides javax.lang.model.util.ElementScanner6.visitType.

Implements javax.lang.model.element.ElementVisitor.visitType.

Doc from javax.lang.model.element.ElementVisitor.visitType.

Visits a type element.

Implementation Specification

This implementation scans the type parameters, if any, and then the enclosed elements.

Parameters
e:TypeElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

Doc from javax.lang.model.util.ElementScanner6.visitType.

the result of scanning

Annotations
@Override