Void
for visitors that do not need to return results.
Void
for visitors that do not need an
additional parameter.
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.
ElementScanner7
, ElementScanner8
, ElementScanner9
, ElementScanner14
Modifier and Type | Field and Description |
---|---|
protected final R | DEFAULT_VALUE
The specified default value. |
Access | Constructor 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.
|
Modifier and Type | Method and Description |
---|---|
public final R | Returns: the scan of the last element orDEFAULT_VALUE if no elementsthe elements to scan iterable, P additional parameter p)Iterates over the given elements and calls |
public R | |
public final R | |
public R | Returns: the result of scanningthe element to visit e, P a visitor-specified parameter p)Implements javax. |
public R | Returns: the result of scanningthe element to visit e, P a visitor-specified parameter p)Implements javax. |
public R | Returns: the result of scanningthe element to visit e, P a visitor-specified parameter p)Overrides javax. Overrides default javax. |
public R | Returns: the result of scanningthe element to visit e, P a visitor-specified parameter p)Implements javax. |
public R | Returns: the result of scanningthe element to visit e, P a visitor-specified parameter p)Implements javax. |
public R | Returns: the result of scanningthe element to visit e, P a visitor-specified parameter p)Implements javax. |
DEFAULT_VALUE | back to summary |
---|---|
protected final R DEFAULT_VALUE The specified default value. |
ElementScanner6 | back 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
|
ElementScanner6 | back 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.
|
scan | back to summary |
---|---|
public final R scan(Iterable<? extends Element> iterable, P p) Iterates over the given elements and calls |
scan | back to summary |
---|---|
public R scan(Element e, P p) Processes an element by calling
|
scan | back to summary |
---|---|
public final R scan(Element e) Convenience method equivalent to
|
visitExecutable | back to summary |
---|---|
public R visitExecutable(ExecutableElement e, P p) Implements javax. Doc from javax. Visits an executable element. Implementation Specification This implementation scans the parameters. Note that type parameters are not scanned by this implementation.
|
visitPackage | back to summary |
---|---|
public R visitPackage(PackageElement e, P p) Implements javax. Doc from javax. Visits a package element. Implementation Specification This implementation scans the enclosed elements.
|
visitRecordComponent | back to summary |
---|---|
public R visitRecordComponent(RecordComponentElement e, P p) Overrides javax. Overrides default javax. Doc from javax. Visits a record component element. Implementation Specification This implementation calls
|
visitType | back to summary |
---|---|
public R visitType(TypeElement e, P p) Implements javax. Doc from javax. 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.
|
visitTypeParameter | back to summary |
---|---|
public R visitTypeParameter(TypeParameterElement e, P p) Implements javax. Doc from javax. Visits a type parameter element. Implementation Specification This implementation scans the enclosed elements.
|
visitVariable | back to summary |
---|---|
public R visitVariable(VariableElement e, P p) Implements javax. Doc from javax. Visits a variable element. Implementation Specification This implementation scans the enclosed elements, unless the
element is a
|