- java.lang.Object
-
- javax.lang.model.util.AbstractElementVisitor6<R,P>
-
- javax.lang.model.util.ElementScanner6<R,P>
-
- Type Parameters:
R
- the return type of this visitor's methods. UseVoid
for visitors that do not need to return results.P
- the type of the additional parameter to this visitor's methods. UseVoid
for visitors that do not need an additional parameter.
- All Implemented Interfaces:
- ElementVisitor<R,P>
- Direct Known Subclasses:
- ElementScanner7
@SupportedSourceVersion(value=RELEASE_6) public class ElementScanner6<R,P> extends AbstractElementVisitor6<R,P>
A scanning visitor of program elements with default behavior appropriate for theRELEASE_6
source version. The visitXYZ methods in this class scan their component elements by callingscan
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 invokingv.scan(e, p)
rather thanv.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.- Since:
- 1.6
- See Also:
ElementScanner7
-
-
Field Summary
Fields Modifier and Type Field and Description protected R
DEFAULT_VALUE
The specified default value.
-
Constructor Summary
Constructors Modifier Constructor and Description protected
ElementScanner6()
Constructor for concrete subclasses; usesnull
for the default value.protected
ElementScanner6(R defaultValue)
Constructor for concrete subclasses; uses the argument for the default value.
-
Method Summary
Methods Modifier and Type Method and Description R
scan(Element e)
Convenience method equivalent tov.scan(e, null)
.R
scan(Element e, P p)
Processes an element by callinge.accept(this, p)
; this method may be overridden by subclasses.R
scan(Iterable<? extends Element> iterable, P p)
Iterates over the given elements and callsscan(Element, P)
on each one.R
visitExecutable(ExecutableElement e, P p)
Visits an executable element.R
visitPackage(PackageElement e, P p)
Visits a package element.R
visitType(TypeElement e, P p)
Visits a type element.R
visitTypeParameter(TypeParameterElement e, P p)
Visits a type parameter element.R
visitVariable(VariableElement e, P p)
Visits a variable element.-
Methods inherited from class javax.lang.model.util.AbstractElementVisitor6
visit, visit, visitUnknown
-
-
-
-
Field Detail
-
DEFAULT_VALUE
protected final R DEFAULT_VALUE
The specified default value.
-
-
Constructor Detail
-
ElementScanner6
protected ElementScanner6()
Constructor for concrete subclasses; usesnull
for the default value.
-
ElementScanner6
protected ElementScanner6(R defaultValue)
Constructor for concrete subclasses; uses the argument for the default value.
-
-
Method Detail
-
scan
public final R scan(Iterable<? extends Element> iterable, P p)
Iterates over the given elements and callsscan(Element, P)
on each one. Returns the result of the last call toscan
orDEFAULT_VALUE
for an empty iterable.- Parameters:
iterable
- the elements to scanp
- additional parameter- Returns:
- the scan of the last element or
DEFAULT_VALUE
if no elements
-
scan
public R scan(Element e, P p)
Processes an element by callinge.accept(this, p)
; this method may be overridden by subclasses.- Returns:
- the result of visiting
e
.
-
scan
public final R scan(Element e)
Convenience method equivalent tov.scan(e, null)
.- Returns:
- the result of scanning
e
.
-
visitPackage
public R visitPackage(PackageElement e, P p)
Visits a package element. This implementation scans the enclosed elements.- Parameters:
e
- the element to visitp
- a visitor-specified parameter- Returns:
- the result of scanning
-
visitType
public R visitType(TypeElement e, P p)
Visits a type element. This implementation scans the enclosed elements.- Parameters:
e
- the element to visitp
- a visitor-specified parameter- Returns:
- the result of scanning
-
visitVariable
public R visitVariable(VariableElement e, P p)
Visits a variable element. This implementation scans the enclosed elements, unless the element is aRESOURCE_VARIABLE
in which casevisitUnknown
is called.- Parameters:
e
- the element to visitp
- a visitor-specified parameter- Returns:
- the result of scanning
-
visitExecutable
public R visitExecutable(ExecutableElement e, P p)
Visits an executable element. This implementation scans the parameters.- Parameters:
e
- the element to visitp
- a visitor-specified parameter- Returns:
- the result of scanning
-
visitTypeParameter
public R visitTypeParameter(TypeParameterElement e, P p)
Visits a type parameter element. This implementation scans the enclosed elements.- Parameters:
e
- the element to visitp
- a visitor-specified parameter- Returns:
- the result of scanning
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/lang/model/util/ElementScanner6.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.