| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class ElementScanner6 extends AbstractElementVisitor6
A scanning visitor of program elements with default behavior appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6} source version. The visitXYZ methods in this class scan their component elements by calling {@code scan} on their {@linkplain Element#getEnclosedElements enclosed elements}, {@linkplain ExecutableElement#getParameters 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 {@code v.scan(e, p)} rather than {@code 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 {@code 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 {@link java.lang.Override @Override} will help ensure that methods are overridden as intended.
WARNING: The {@code 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 {@code "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 {@code "visit"}.
When such a new visit method is added, the default implementation in this class will be to call the {@link #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.
Field Summary | |
---|---|
protected Object |
DEFAULT_VALUE
The specified default value. |
Constructor Summary | |
---|---|
protected |
Constructor for concrete subclasses; uses for the default value. |
protected |
ElementScanner6(Object defaultValue) Constructor for concrete subclasses; uses the argument for the default value. |
Method Summary | |
---|---|
Object |
Convenience method equivalent to . |
Object |
Processes an element by calling ; this method may be overridden by subclasses. |
Object |
Iterates over the given elements and calls javax.lang.model.util.ElementScanner6.scan on each one. |
Object |
This implementation scans the parameters. |
Object |
visitPackage(PackageElement e, Object p) This implementation scans the enclosed elements. |
Object |
visitType(TypeElement e, Object p) This implementation scans the enclosed elements. |
Object |
This implementation scans the enclosed elements. |
Object |
This implementation scans the enclosed elements. |
Methods inherited from class javax.lang.model.util.AbstractElementVisitor6 |
---|
visit, visit, visitUnknown |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Object DEFAULT_VALUE
Constructor Detail |
---|
protected ElementScanner6()
protected ElementScanner6(Object defaultValue)
defaultValue
Method Detail |
---|
public final Object scan(Element e)
e
public Object scan(Element e, Object p)
e
p
public final Object scan(Iterable iterable, Object p)
iterable
- the elements to scanp
- additional parameterpublic Object visitExecutable(ExecutableElement e, Object p)
e
- the element to visitp
- a visitor-specified parameterpublic Object visitPackage(PackageElement e, Object p)
e
- the element to visitp
- a visitor-specified parameterpublic Object visitType(TypeElement e, Object p)
e
- the element to visitp
- a visitor-specified parameterpublic Object visitTypeParameter(TypeParameterElement e, Object p)
e
- the element to visitp
- a visitor-specified parameterpublic Object visitVariable(VariableElement e, Object p)
e
- the element to visitp
- a visitor-specified parameter
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |