This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.lang.model.util
class ElementKindVisitor6

java.lang.Object extended by javax.lang.model.util.AbstractElementVisitor6 extended by javax.lang.model.util.SimpleElementVisitor6 extended by javax.lang.model.util.ElementKindVisitor6
All Implemented Interfaces:
ElementVisitor

public class ElementKindVisitor6
extends SimpleElementVisitor6

A visitor of program elements based on their {@linkplain ElementKind kind} with default behavior appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6} source version. For {@linkplain Element elements} XYZ that may have more than one kind, the visitXYZ methods in this class delegate to the visitXYZKind method corresponding to the first argument's kind. The visitXYZKind methods call {@link #defaultAction defaultAction}, passing their arguments to {@code defaultAction}'s corresponding parameters.

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 or the {@code ElementKind} {@code enum} used in this case may have constants 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 abstract element kind 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
 
Fields inherited from class javax.lang.model.util.SimpleElementVisitor6
DEFAULT_VALUE
 
Constructor Summary
protected

          Constructor for concrete subclasses; uses for the default value.
protected

          Constructor for concrete subclasses; uses the argument for the default value.
 
Method Summary
 Object

          Visits an executable element, dispatching to the visit method for the specific javax.lang.model.element.ElementKind of executable, , , , or .
 Object

          Visits a executable element by calling .
 Object

          Visits an executable element by calling .
 Object

          Visits a executable element by calling .
 Object

          Visits a executable element by calling .
 Object

           The element argument has kind .
 Object

          Visits a type element, dispatching to the visit method for the specific javax.lang.model.element.ElementKind of type, , , , or .
 Object

          Visits an type element by calling .
 Object

          Visits a type element by calling .
 Object

          Visits an type element by calling .
 Object

          Visits an type element by calling .
 Object

           The element argument has kind .
 Object

          Visits a variable element, dispatching to the visit method for the specific javax.lang.model.element.ElementKind of variable, , , , , or .
 Object

          Visits an variable element by calling .
 Object

          Visits an variable element by calling .
 Object

          Visits a variable element by calling .
 Object

          Visits a variable element by calling .
 Object

          Visits a variable element by calling .
 
Methods inherited from class javax.lang.model.util.SimpleElementVisitor6
defaultAction, visitExecutable, visitPackage, visitType, visitTypeParameter, visitVariable
 
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
 

Constructor Detail

ElementKindVisitor6

protected ElementKindVisitor6()
Constructor for concrete subclasses; uses {@code null} for the default value.


ElementKindVisitor6

protected ElementKindVisitor6(Object defaultValue)
Constructor for concrete subclasses; uses the argument for the default value.

Parameters:
defaultValue - the value to assign to {@link #DEFAULT_VALUE}
Method Detail

visitExecutable

public Object visitExecutable(ExecutableElement e,
                              Object p)
Visits an executable element, dispatching to the visit method for the specific {@linkplain ElementKind kind} of executable, {@code CONSTRUCTOR}, {@code INSTANCE_INIT}, {@code METHOD}, or {@code STATIC_INIT}.

Overrides:
visitExecutable in class SimpleElementVisitor6
Parameters:
e - {@inheritDoc}
p - {@inheritDoc}
Returns:
the result of the kind-specific visit method

visitExecutableAsConstructor

public Object visitExecutableAsConstructor(ExecutableElement e,
                                           Object p)
Visits a {@code CONSTRUCTOR} executable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitExecutableAsInstanceInit

public Object visitExecutableAsInstanceInit(ExecutableElement e,
                                            Object p)
Visits an {@code INSTANCE_INIT} executable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitExecutableAsMethod

public Object visitExecutableAsMethod(ExecutableElement e,
                                      Object p)
Visits a {@code METHOD} executable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitExecutableAsStaticInit

public Object visitExecutableAsStaticInit(ExecutableElement e,
                                          Object p)
Visits a {@code STATIC_INIT} executable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitPackage

public Object visitPackage(PackageElement e,
                           Object p)
{@inheritDoc} The element argument has kind {@code PACKAGE}.

Overrides:
visitPackage in class SimpleElementVisitor6
Parameters:
e - {@inheritDoc}
p - {@inheritDoc}
Returns:
{@inheritDoc}

visitType

public Object visitType(TypeElement e,
                        Object p)
Visits a type element, dispatching to the visit method for the specific {@linkplain ElementKind kind} of type, {@code ANNOTATION_TYPE}, {@code CLASS}, {@code ENUM}, or {@code INTERFACE}.

Overrides:
visitType in class SimpleElementVisitor6
Parameters:
e - {@inheritDoc}
p - {@inheritDoc}
Returns:
the result of the kind-specific visit method

visitTypeAsAnnotationType

public Object visitTypeAsAnnotationType(TypeElement e,
                                        Object p)
Visits an {@code ANNOTATION_TYPE} type element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitTypeAsClass

public Object visitTypeAsClass(TypeElement e,
                               Object p)
Visits a {@code CLASS} type element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitTypeAsEnum

public Object visitTypeAsEnum(TypeElement e,
                              Object p)
Visits an {@code ENUM} type element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitTypeAsInterface

public Object visitTypeAsInterface(TypeElement e,
                                   Object p)
Visits an {@code INTERFACE} type element by calling {@code defaultAction}. .

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitTypeParameter

public Object visitTypeParameter(TypeParameterElement e,
                                 Object p)
{@inheritDoc} The element argument has kind {@code TYPE_PARAMETER}.

Overrides:
visitTypeParameter in class SimpleElementVisitor6
Parameters:
e - {@inheritDoc}
p - {@inheritDoc}
Returns:
{@inheritDoc}

visitVariable

public Object visitVariable(VariableElement e,
                            Object p)
Visits a variable element, dispatching to the visit method for the specific {@linkplain ElementKind kind} of variable, {@code ENUM_CONSTANT}, {@code EXCEPTION_PARAMETER}, {@code FIELD}, {@code LOCAL_VARIABLE}, or {@code PARAMETER}.

Overrides:
visitVariable in class SimpleElementVisitor6
Parameters:
e - {@inheritDoc}
p - {@inheritDoc}
Returns:
the result of the kind-specific visit method

visitVariableAsEnumConstant

public Object visitVariableAsEnumConstant(VariableElement e,
                                          Object p)
Visits an {@code ENUM_CONSTANT} variable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitVariableAsExceptionParameter

public Object visitVariableAsExceptionParameter(VariableElement e,
                                                Object p)
Visits an {@code EXCEPTION_PARAMETER} variable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitVariableAsField

public Object visitVariableAsField(VariableElement e,
                                   Object p)
Visits a {@code FIELD} variable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitVariableAsLocalVariable

public Object visitVariableAsLocalVariable(VariableElement e,
                                           Object p)
Visits a {@code LOCAL_VARIABLE} variable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}

visitVariableAsParameter

public Object visitVariableAsParameter(VariableElement e,
                                       Object p)
Visits a {@code PARAMETER} variable element by calling {@code defaultAction}.

Parameters:
e - the element to visit
p - a visitor-specified parameter
Returns:
the result of {@code defaultAction}


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.