ElementScanner6 JDK 1.6)

Description

@SupportedSourceVersion (value=RELEASE_6)
public class ElementScanner6

A scanning visitor of program elements with default behavior appropriate for the RELEASE_6 source version.

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

See also:

Methods

Hide/Show inherited methods

publicfinal R scan (Element e)

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

Convenience method equivalent to v.scan(e, null).
Returns: the result of scanning {@code e}.

public R scan (Element e, P p)

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

Processes an element by calling e.accept(this, p);
this method may be overridden by subclasses.
Returns: the result of visiting {@code e}.

publicfinal R scan (Iterable<Element> iterable, P p)

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

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.
Returns: the scan of the last element or {@code DEFAULT_VALUE} if no elements
Parameters:
- iterable - the elements to scan
- p - additional parameter

publicfinal R visit (Element e) [Inherited From AbstractElementVisitor6]

Visits any program element as if by passing itself to that element's accept method and passing null for the additional parameter.

Visits any program element as if by passing itself to that
element's accept method and passing
null for the additional parameter. The invocation
v.visit(elem) is equivalent to

elem.accept(v,
 null)

.
Returns: a visitor-specified result
Parameters:
- e - the element to visit

publicfinal R visit (Element e, P p) [Inherited From AbstractElementVisitor6]

Visits any program element as if by passing itself to that element's accept method.

Visits any program element as if by passing itself to that
element's accept method. The invocation
v.visit(elem) is equivalent to

elem.accept(v,
 p)

.
Returns: a visitor-specified result
Parameters:
- e - the element to visit
- p - a visitor-specified parameter

public R visitExecutable (ExecutableElement e, P p)

Visits an executable element. This implementation scans the parameters.

public R visitPackage (PackageElement e, P p)

Visits a package element. This implementation scans the enclosed elements.

public R visitType (TypeElement e, P p)

Visits a type element. This implementation scans the enclosed elements.

public R visitTypeParameter (TypeParameterElement e, P p)

Visits a type parameter element. This implementation scans the enclosed elements.

public R visitUnknown (Element e, P p) [Inherited From AbstractElementVisitor6]

Visits an unknown kind of element.

Visits an unknown kind of element. This can occur if the language evolves and new kinds of elements are added to the Element hierarchy.

The default implementation of this method in AbstractElementVisitor6 will always throw UnknownElementException. This behavior is not required of a subclass.
Returns: a visitor-specified result
Parameters:
- e - the element to visit
- p - a visitor-specified parameter
Throws:
- UnknownElementException - a visitor implementation may optionally throw this exception

public R visitVariable (VariableElement e, P p)

Visits a variable element. This implementation scans the enclosed elements.