| javax.lang.model.util.ElementScanner6
| ElementScanner6 | | public class ElementScanner6 extends AbstractElementVisitor6 (Code) | | A scanning visitor of program elements with default behavior
appropriate for the
SourceVersion.RELEASE_6 RELEASE_6 source version. The visitXYZ methods in this
class scan their component elements by calling
scan on
their
,
, 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
java.lang.Override @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
ElementScanner6.visitUnknown 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.
<
Parameters:
R - > the return type of this visitor's methods. Use Void for visitors that do not need to return results.<
Parameters:
P - > the type of the additional parameter to this visitor'smethods. Use Void for visitors that do not need anadditional parameter.
author:
Joseph D. Darcy
author:
Scott Seligman
author:
Peter von der Ahé
version:
1.13 07/05/05
since:
1.6 |
| Field Summary | |
| final protected R | DEFAULT_VALUE
The specified default value. |
| Constructor Summary | |
| protected | ElementScanner6()
Constructor for concrete subclasses; uses
null for the
default value. | | protected | ElementScanner6(R defaultValue)
Constructor for concrete subclasses; uses the argument for the
default value. |
| Method Summary | |
| final public R | scan(Iterable<? extends Element> iterable, P p)
Iterates over the given elements and calls
ElementScanner6.scan(Element,Object) scan(Element, P) on each one. | | public R | scan(Element e, P p)
Processes an element by calling
e.accept(this, p) ;
this method may be overridden by subclasses. | | final public R | scan(Element e)
Convenience method equivalent to
v.scan(e, null) . | | public R | visitExecutable(ExecutableElement e, P p)
This implementation scans the parameters. | | public R | visitPackage(PackageElement e, P p)
This implementation scans the enclosed elements. | | public R | visitType(TypeElement e, P p)
This implementation scans the enclosed elements. | | public R | visitTypeParameter(TypeParameterElement e, P p)
This implementation scans the enclosed elements. | | public R | visitVariable(VariableElement e, P p)
This implementation scans the enclosed elements. |
| DEFAULT_VALUE | | final protected R DEFAULT_VALUE(Code) | | The specified default value.
|
| ElementScanner6 | | protected ElementScanner6()(Code) | | Constructor for concrete subclasses; uses
null for the
default value.
|
| ElementScanner6 | | protected ElementScanner6(R defaultValue)(Code) | | Constructor for concrete subclasses; uses the argument for the
default value.
|
| scan | | final public R scan(Iterable<? extends Element> iterable, P p)(Code) | | Iterates over the given elements and calls
ElementScanner6.scan(Element,Object) scan(Element, P) on each one. Returns
the result of the last call to
scan or
DEFAULT_VALUE for an empty iterable.
Parameters:
iterable - the elements to scan
Parameters:
p - additional parameter the scan of the last element or DEFAULT_VALUE if no elements |
| scan | | public R scan(Element e, P p)(Code) | | Processes an element by calling
e.accept(this, p) ;
this method may be overridden by subclasses.
the result of visiting e . |
| scan | | final public R scan(Element e)(Code) | | Convenience method equivalent to
v.scan(e, null) .
the result of scanning e . |
| visitExecutable | | public R visitExecutable(ExecutableElement e, P p)(Code) | | This implementation scans the parameters.
Parameters:
e - the element to visit
Parameters:
p - a visitor-specified parameter the result of scanning |
| visitPackage | | public R visitPackage(PackageElement e, P p)(Code) | | This implementation scans the enclosed elements.
Parameters:
e - the element to visit
Parameters:
p - a visitor-specified parameter the result of scanning |
| visitType | | public R visitType(TypeElement e, P p)(Code) | | This implementation scans the enclosed elements.
Parameters:
e - the element to visit
Parameters:
p - a visitor-specified parameter the result of scanning |
| visitTypeParameter | | public R visitTypeParameter(TypeParameterElement e, P p)(Code) | | This implementation scans the enclosed elements.
Parameters:
e - the element to visit
Parameters:
p - a visitor-specified parameter the result of scanning |
| visitVariable | | public R visitVariable(VariableElement e, P p)(Code) | | This implementation scans the enclosed elements.
Parameters:
e - the element to visit
Parameters:
p - a visitor-specified parameter the result of scanning |
|
|