当前页面: 在线文档首页 > JDK 5 Documentation v6.0, Java 2 SDK 英文文档

ElementVisitor (Java Platform SE 6) - JDK 5 Documentation v6.0, Java 2 SDK 英文文档

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help		Java™ Platform Standard Ed. 6
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.lang.model.element
Interface ElementVisitor<R,P>

Type Parameters:

R - the return type of this visitor's methods. Use Void for visitors that do not need to return results.

P - the type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.

All Known Implementing Classes:

AbstractElementVisitor6, ElementKindVisitor6, ElementScanner6, SimpleElementVisitor6

---

public interface ElementVisitor<R,P>

A visitor of program elements, in the style of the visitor design pattern. Classes implementing this interface are used to operate on an element when the kind of element is unknown at compile time. When a visitor is passed to an element's accept method, the visitXYZ method most applicable to that element is invoked.

Classes implementing this interface may or may not throw a NullPointerException if the additional parameter p is null; see documentation of the implementing class for details.

WARNING: It is possible that methods will be added to this interface to accommodate new, currently unknown, language structures added to future versions of the Java™ programming language. Therefore, visitor classes directly implementing this interface may be source incompatible with future versions of the platform. To avoid this source incompatibility, visitor implementations are encouraged to instead extend the appropriate abstract visitor class that implements this interface. However, an API should generally use this visitor interface as the type for parameters, return type, etc. rather than one of the abstract classes.

Since:

1.6

See Also:

AbstractElementVisitor6

---

Method Summary
R	visit(Element e)           A convenience method equivalent to v.visit(e, null).
R	visit(Element e, P p)           Visits an element.
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	visitUnknown(Element e, P p)           Visits an unknown kind of element.
R	visitVariable(VariableElement e, P p)           Visits a variable element.

 

Method Detail

visit

R visit(Element e,
        P p)

Visits an element.

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

---

visit

R visit(Element e)

A convenience method equivalent to v.visit(e, null).

Parameters:

e - the element to visit

Returns:

a visitor-specified result

---

visitPackage

R visitPackage(PackageElement e,
               P p)

Visits a package element.

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

---

visitType

R visitType(TypeElement e,
            P p)

Visits a type element.

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

---

visitVariable

R visitVariable(VariableElement e,
                P p)

Visits a variable element.

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

---

visitExecutable

R visitExecutable(ExecutableElement e,
                  P p)

Visits an executable element.

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

---

visitTypeParameter

R visitTypeParameter(TypeParameterElement e,
                     P p)

Visits a type parameter element.

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

---

visitUnknown

R visitUnknown(Element e,
               P p)

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

Parameters:

e - the element to visit

p - a visitor-specified parameter

Returns:

a visitor-specified result

Throws:

UnknownElementException - a visitor implementation may optionally throw this exception

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help		Java™ Platform Standard Ed. 6
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.