aoqi@0: /*
aoqi@0:  * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.source.doctree;
aoqi@0: 
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A visitor of trees, in the style of the visitor design pattern.
aoqi@0:  * Classes implementing this interface are used to operate
aoqi@0:  * on a tree when the kind of tree is unknown at compile time.
aoqi@0:  * When a visitor is passed to an tree's {@link DocTree#accept
aoqi@0:  * accept} method, the <tt>visit<i>XYZ</i></tt> method most applicable
aoqi@0:  * to that tree is invoked.
aoqi@0:  *
aoqi@0:  * <p> Classes implementing this interface may or may not throw a
aoqi@0:  * {@code NullPointerException} if the additional parameter {@code p}
aoqi@0:  * is {@code null}; see documentation of the implementing class for
aoqi@0:  * details.
aoqi@0:  *
aoqi@0:  * <p> <b>WARNING:</b> It is possible that methods will be added to
aoqi@0:  * this interface to accommodate new, currently unknown, doc comment
aoqi@0:  * structures added to future versions of the Java&trade; programming
aoqi@0:  * language.  Therefore, visitor classes directly implementing this
aoqi@0:  * interface may be source incompatible with future versions of the
aoqi@0:  * platform.
aoqi@0:  *
aoqi@0:  * @param <R> the return type of this visitor's methods.  Use {@link
aoqi@0:  *            Void} for visitors that do not need to return results.
aoqi@0:  * @param <P> the type of the additional parameter to this visitor's
aoqi@0:  *            methods.  Use {@code Void} for visitors that do not need an
aoqi@0:  *            additional parameter.
aoqi@0:  *
aoqi@0:  * @since 1.8
aoqi@0:  */
aoqi@0: @jdk.Exported
aoqi@0: public interface DocTreeVisitor<R,P> {
aoqi@0:     R visitAttribute(AttributeTree node, P p);
aoqi@0:     R visitAuthor(AuthorTree node, P p);
aoqi@0:     R visitComment(CommentTree node, P p);
aoqi@0:     R visitDeprecated(DeprecatedTree node, P p);
aoqi@0:     R visitDocComment(DocCommentTree node, P p);
aoqi@0:     R visitDocRoot(DocRootTree node, P p);
aoqi@0:     R visitEndElement(EndElementTree node, P p);
aoqi@0:     R visitEntity(EntityTree node, P p);
aoqi@0:     R visitErroneous(ErroneousTree node, P p);
aoqi@0:     R visitIdentifier(IdentifierTree node, P p);
aoqi@0:     R visitInheritDoc(InheritDocTree node, P p);
aoqi@0:     R visitLink(LinkTree node, P p);
aoqi@0:     R visitLiteral(LiteralTree node, P p);
aoqi@0:     R visitParam(ParamTree node, P p);
aoqi@0:     R visitReference(ReferenceTree node, P p);
aoqi@0:     R visitReturn(ReturnTree node, P p);
aoqi@0:     R visitSee(SeeTree node, P p);
aoqi@0:     R visitSerial(SerialTree node, P p);
aoqi@0:     R visitSerialData(SerialDataTree node, P p);
aoqi@0:     R visitSerialField(SerialFieldTree node, P p);
aoqi@0:     R visitSince(SinceTree node, P p);
aoqi@0:     R visitStartElement(StartElementTree node, P p);
aoqi@0:     R visitText(TextTree node, P p);
aoqi@0:     R visitThrows(ThrowsTree node, P p);
aoqi@0:     R visitUnknownBlockTag(UnknownBlockTagTree node, P p);
aoqi@0:     R visitUnknownInlineTag(UnknownInlineTagTree node, P p);
aoqi@0:     R visitValue(ValueTree node, P p);
aoqi@0:     R visitVersion(VersionTree node, P p);
aoqi@0:     R visitOther(DocTree node, P p);
aoqi@0: }