1/*
2 * Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.lang.model.util;
27
28import javax.annotation.processing.SupportedSourceVersion;
29import javax.lang.model.SourceVersion;
30import javax.lang.model.element.ModuleElement;
31import static javax.lang.model.SourceVersion.*;
32
33
34/**
35 * A skeletal visitor of program elements with default behavior
36 * appropriate for the {@link SourceVersion#RELEASE_9 RELEASE_9}
37 * source version.
38 *
39 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
40 * implemented by this class may have methods added to it in the
41 * future to accommodate new, currently unknown, language structures
42 * added to future versions of the Java&trade; programming language.
43 * Therefore, methods whose names begin with {@code "visit"} may be
44 * added to this class in the future; to avoid incompatibilities,
45 * classes which extend this class should not declare any instance
46 * methods with names beginning with {@code "visit"}.
47 *
48 * <p>When such a new visit method is added, the default
49 * implementation in this class will be to call the {@link
50 * #visitUnknown visitUnknown} method.  A new abstract element visitor
51 * class will also be introduced to correspond to the new language
52 * level; this visitor will have different default behavior for the
53 * visit method in question.  When the new visitor is introduced, all
54 * or portions of this visitor may be deprecated.
55 *
56 * @param <R> the return type of this visitor's methods.  Use {@link
57 *            Void} for visitors that do not need to return results.
58 * @param <P> the type of the additional parameter to this visitor's
59 *            methods.  Use {@code Void} for visitors that do not need an
60 *            additional parameter.
61 *
62 * @see AbstractElementVisitor6
63 * @see AbstractElementVisitor7
64 * @see AbstractElementVisitor8
65 * @since 9
66 * @spec JPMS
67 */
68@SupportedSourceVersion(RELEASE_9)
69public abstract class AbstractElementVisitor9<R, P> extends AbstractElementVisitor8<R, P> {
70    /**
71     * Constructor for concrete subclasses to call.
72     */
73    protected AbstractElementVisitor9(){
74        super();
75    }
76
77    /**
78     * Visits a {@code ModuleElement} in a manner defined by a
79     * subclass.
80     *
81     * @param t  {@inheritDoc}
82     * @param p  {@inheritDoc}
83     * @return the result of the visit as defined by a subclass
84     */
85    @Override
86    public abstract R visitModule(ModuleElement t, P p);
87}
88