javax.lang.model.util

Class ElementKindVisitor6<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 Implemented Interfaces:
    ElementVisitor<R,P>
    Direct Known Subclasses:
    ElementKindVisitor7 

    @SupportedSourceVersion(value=RELEASE_6)
public class ElementKindVisitor6<R,P>
extends SimpleElementVisitor6<R,P>
    A visitor of program elements based on their kind with default behavior appropriate for the RELEASE_6 source version. For 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 defaultAction, passing their arguments to defaultAction's corresponding parameters.

    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 or the ElementKind 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 "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 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.

    Note that adding a default implementation of a new visit method in a visitor class will occur instead of adding a default method directly in the visitor interface since a Java SE 8 language feature cannot be used to this version of the API since this version is required to be runnable on Java SE 7 implementations. Future versions of the API that are only required to run on Java SE 8 and later may take advantage of default methods in this situation.

    Since:
    1.6
    See Also:
    ElementKindVisitor7, ElementKindVisitor8

    • Constructor Detail

      • ElementKindVisitor6

        protected ElementKindVisitor6()
        Constructor for concrete subclasses; uses null for the default value.

      • ElementKindVisitor6

        protected ElementKindVisitor6(R defaultValue)
        Constructor for concrete subclasses; uses the argument for the default value.
        Parameters:
        defaultValue - the value to assign to SimpleElementVisitor6.DEFAULT_VALUE

    • Method Detail

      • visitPackage

        public R visitPackage(PackageElement e,
                      P p)
        Visits a package element. This implementation calls defaultAction. The element argument has kind PACKAGE.
        Specified by:
        visitPackage in interface  ElementVisitor<R,P>
        Overrides:
        visitPackage in class  SimpleElementVisitor6<R,P>
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitType

        public R visitType(TypeElement e,
                   P p)
        Visits a type element, dispatching to the visit method for the specific kind of type, ANNOTATION_TYPE, CLASS, ENUM, or INTERFACE.
        Specified by:
        visitType in interface  ElementVisitor<R,P>
        Overrides:
        visitType in class  SimpleElementVisitor6<R,P>
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of the kind-specific visit method

      • visitTypeAsAnnotationType

        public R visitTypeAsAnnotationType(TypeElement e,
                                   P p)
        Visits an ANNOTATION_TYPE type element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitTypeAsClass

        public R visitTypeAsClass(TypeElement e,
                          P p)
        Visits a CLASS type element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitTypeAsEnum

        public R visitTypeAsEnum(TypeElement e,
                         P p)
        Visits an ENUM type element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitTypeAsInterface

        public R visitTypeAsInterface(TypeElement e,
                              P p)
        Visits an INTERFACE type element by calling defaultAction. .
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitVariable

        public R visitVariable(VariableElement e,
                       P p)
        Visits a variable element, dispatching to the visit method for the specific kind of variable, ENUM_CONSTANT, EXCEPTION_PARAMETER, FIELD, LOCAL_VARIABLE, PARAMETER, or RESOURCE_VARIABLE.
        Specified by:
        visitVariable in interface  ElementVisitor<R,P>
        Overrides:
        visitVariable in class  SimpleElementVisitor6<R,P>
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of the kind-specific visit method

      • visitVariableAsEnumConstant

        public R visitVariableAsEnumConstant(VariableElement e,
                                     P p)
        Visits an ENUM_CONSTANT variable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitVariableAsExceptionParameter

        public R visitVariableAsExceptionParameter(VariableElement e,
                                           P p)
        Visits an EXCEPTION_PARAMETER variable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitVariableAsField

        public R visitVariableAsField(VariableElement e,
                              P p)
        Visits a FIELD variable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitVariableAsLocalVariable

        public R visitVariableAsLocalVariable(VariableElement e,
                                      P p)
        Visits a LOCAL_VARIABLE variable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitVariableAsParameter

        public R visitVariableAsParameter(VariableElement e,
                                  P p)
        Visits a PARAMETER variable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitVariableAsResourceVariable

        public R visitVariableAsResourceVariable(VariableElement e,
                                         P p)
        Visits a RESOURCE_VARIABLE variable element by calling visitUnknown.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of visitUnknown
        Since:
        1.7

      • visitExecutable

        public R visitExecutable(ExecutableElement e,
                         P p)
        Visits an executable element, dispatching to the visit method for the specific kind of executable, CONSTRUCTOR, INSTANCE_INIT, METHOD, or STATIC_INIT.
        Specified by:
        visitExecutable in interface  ElementVisitor<R,P>
        Overrides:
        visitExecutable in class  SimpleElementVisitor6<R,P>
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of the kind-specific visit method

      • visitExecutableAsConstructor

        public R visitExecutableAsConstructor(ExecutableElement e,
                                      P p)
        Visits a CONSTRUCTOR executable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitExecutableAsInstanceInit

        public R visitExecutableAsInstanceInit(ExecutableElement e,
                                       P p)
        Visits an INSTANCE_INIT executable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitExecutableAsMethod

        public R visitExecutableAsMethod(ExecutableElement e,
                                 P p)
        Visits a METHOD executable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction

      • visitExecutableAsStaticInit

        public R visitExecutableAsStaticInit(ExecutableElement e,
                                     P p)
        Visits a STATIC_INIT executable element by calling defaultAction.
        Parameters:
        e - the element to visit
        p - a visitor-specified parameter
        Returns:
        the result of defaultAction