Top Description Fields Constructors Methods
javax.lang.model.util

public Class ElementScanner6<R, P>

extends AbstractElementVisitor6<R, P>
Class Inheritance
Known Direct Subclasses
javax.lang.model.util.ElementScanner7
Annotations
@SupportedSourceVersion:RELEASE_6
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
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_6 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.

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 directly or indirectly 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 a new visitor is introduced, portions of this visitor class may be deprecated, including its constructors.

Since
1.6
See Also
ElementScanner7, ElementScanner8, ElementScanner9, ElementScanner14

Field Summary

Modifier and TypeField and Description
protected final R
DEFAULT_VALUE

The specified default value.

Constructor Summary

AccessConstructor and Description
protected
ElementScanner6()

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

Deprecated since 9. Release 6 is obsolete; update to a visitor for a newer release level.
Constructor for concrete subclasses; uses the argument for the default value.

Method Summary

Modifier and TypeMethod and Description
public final R

Returns:

the scan of the last element or DEFAULT_VALUE if no elements
scan
(Iterable<? extends Element>
the elements to scan
iterable
,
P
additional parameter
p
)

Iterates over the given elements and calls scan(Element, P) on each one.

public R

Returns:

the result of visiting e.
scan
(Element
the element to scan
e
,
P
a scanner-specified parameter
p
)

Processes an element by calling e.accept(this, p); this method may be overridden by subclasses.

public final R

Returns:

the result of scanning e.
scan
(Element
the element to scan
e
)

Convenience method equivalent to v.scan(e, null).

public R

Returns:

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

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

Visits an executable element.
public R

Returns:

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

Implements javax.lang.model.element.ElementVisitor.visitPackage.

Visits a package 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.AbstractElementVisitor6.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
)

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

Visits a type element.
public R

Returns:

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

Implements javax.lang.model.element.ElementVisitor.visitTypeParameter.

Visits a type parameter element.
public R

Returns:

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

Implements javax.lang.model.element.ElementVisitor.visitVariable.

Visits a variable element.
Inherited from javax.lang.model.util.AbstractElementVisitor6:
visitvisitvisitModulevisitUnknown

Field Detail

DEFAULT_VALUEback to summary
protected final R DEFAULT_VALUE

The specified default value.

Constructor Detail

ElementScanner6back to summary
protected ElementScanner6()

Deprecated

since 9.

Release 6 is obsolete; update to a visitor for a newer release level.

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

Annotations
@Deprecated
since:9
ElementScanner6back to summary
protected ElementScanner6(R defaultValue)

Deprecated

since 9.

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:R

the default value

Annotations
@Deprecated
since:9

Method Detail

scanback to summary
public final R scan(Iterable<? extends Element> iterable, P p)

Iterates over the given elements and calls scan(Element, P) on each one. Returns the result of the last call to scan or DEFAULT_VALUE for an empty iterable.

Parameters
iterable:Iterable<? extends Element>

the elements to scan

p:P

additional parameter

Returns:R

the scan of the last element or DEFAULT_VALUE if no elements

scanback to summary
public R scan(Element e, P p)

Processes an element by calling e.accept(this, p); this method may be overridden by subclasses.

Parameters
e:Element

the element to scan

p:P

a scanner-specified parameter

Returns:R

the result of visiting e.

scanback to summary
public final R scan(Element e)

Convenience method equivalent to v.scan(e, null).

Parameters
e:Element

the element to scan

Returns:R

the result of scanning e.

visitExecutableback to summary
public R visitExecutable(ExecutableElement e, P p)

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

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

Visits an executable element.

Implementation Specification

This implementation scans the parameters. Note that type parameters are not scanned by this implementation.

Parameters
e:ExecutableElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

the result of scanning

Annotations
@Override
visitPackageback to summary
public R visitPackage(PackageElement e, P p)

Implements javax.lang.model.element.ElementVisitor.visitPackage.

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

Visits a package element.

Implementation Specification

This implementation scans the enclosed elements.

Parameters
e:PackageElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

the result of scanning

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

Overrides javax.lang.model.util.AbstractElementVisitor6.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 calls visitUnknown(e, p).

Parameters
e:RecordComponentElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

the result of scanning

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

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 enclosed elements. Note that type parameters are not scanned by this implementation since type parameters are not considered to be enclosed elements of a type.

Parameters
e:TypeElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

the result of scanning

Annotations
@Override
visitTypeParameterback to summary
public R visitTypeParameter(TypeParameterElement e, P p)

Implements javax.lang.model.element.ElementVisitor.visitTypeParameter.

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

Visits a type parameter element.

Implementation Specification

This implementation scans the enclosed elements.

Parameters
e:TypeParameterElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

the result of scanning

Annotations
@Override
visitVariableback to summary
public R visitVariable(VariableElement e, P p)

Implements javax.lang.model.element.ElementVisitor.visitVariable.

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

Visits a variable element.

Implementation Specification

This implementation scans the enclosed elements, unless the element is a RESOURCE_VARIABLE in which case visitUnknown is called.

Parameters
e:VariableElement

the element to visit

p:P

a visitor-specified parameter

Returns:R

the result of scanning

Annotations
@Override