Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/source/doctree/DocTreeVisitor.java@2eb010b6cb22 (annotated)
src/share/classes/com/sun/source/doctree/DocTreeVisitor.java
Thu, 31 Aug 2017 15:17:03 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:17:03 +0800
- changeset 2525
- 2eb010b6cb22
- parent 2083
- 379c04c090cf
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.source.doctree; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | |
| aoqi@0 | 29 | /** |
| aoqi@0 | 30 | * A visitor of trees, in the style of the visitor design pattern. |
| aoqi@0 | 31 | * Classes implementing this interface are used to operate |
| aoqi@0 | 32 | * on a tree when the kind of tree is unknown at compile time. |
| aoqi@0 | 33 | * When a visitor is passed to an tree's {@link DocTree#accept |
| aoqi@0 | 34 | * accept} method, the <tt>visit<i>XYZ</i></tt> method most applicable |
| aoqi@0 | 35 | * to that tree is invoked. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * <p> Classes implementing this interface may or may not throw a |
| aoqi@0 | 38 | * {@code NullPointerException} if the additional parameter {@code p} |
| aoqi@0 | 39 | * is {@code null}; see documentation of the implementing class for |
| aoqi@0 | 40 | * details. |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * <p> <b>WARNING:</b> It is possible that methods will be added to |
| aoqi@0 | 43 | * this interface to accommodate new, currently unknown, doc comment |
| aoqi@0 | 44 | * structures added to future versions of the Java™ programming |
| aoqi@0 | 45 | * language. Therefore, visitor classes directly implementing this |
| aoqi@0 | 46 | * interface may be source incompatible with future versions of the |
| aoqi@0 | 47 | * platform. |
| aoqi@0 | 48 | * |
| aoqi@0 | 49 | * @param <R> the return type of this visitor's methods. Use {@link |
| aoqi@0 | 50 | * Void} for visitors that do not need to return results. |
| aoqi@0 | 51 | * @param <P> the type of the additional parameter to this visitor's |
| aoqi@0 | 52 | * methods. Use {@code Void} for visitors that do not need an |
| aoqi@0 | 53 | * additional parameter. |
| aoqi@0 | 54 | * |
| aoqi@0 | 55 | * @since 1.8 |
| aoqi@0 | 56 | */ |
| aoqi@0 | 57 | @jdk.Exported |
| aoqi@0 | 58 | public interface DocTreeVisitor<R,P> { |
| aoqi@0 | 59 | R visitAttribute(AttributeTree node, P p); |
| aoqi@0 | 60 | R visitAuthor(AuthorTree node, P p); |
| aoqi@0 | 61 | R visitComment(CommentTree node, P p); |
| aoqi@0 | 62 | R visitDeprecated(DeprecatedTree node, P p); |
| aoqi@0 | 63 | R visitDocComment(DocCommentTree node, P p); |
| aoqi@0 | 64 | R visitDocRoot(DocRootTree node, P p); |
| aoqi@0 | 65 | R visitEndElement(EndElementTree node, P p); |
| aoqi@0 | 66 | R visitEntity(EntityTree node, P p); |
| aoqi@0 | 67 | R visitErroneous(ErroneousTree node, P p); |
| aoqi@0 | 68 | R visitIdentifier(IdentifierTree node, P p); |
| aoqi@0 | 69 | R visitInheritDoc(InheritDocTree node, P p); |
| aoqi@0 | 70 | R visitLink(LinkTree node, P p); |
| aoqi@0 | 71 | R visitLiteral(LiteralTree node, P p); |
| aoqi@0 | 72 | R visitParam(ParamTree node, P p); |
| aoqi@0 | 73 | R visitReference(ReferenceTree node, P p); |
| aoqi@0 | 74 | R visitReturn(ReturnTree node, P p); |
| aoqi@0 | 75 | R visitSee(SeeTree node, P p); |
| aoqi@0 | 76 | R visitSerial(SerialTree node, P p); |
| aoqi@0 | 77 | R visitSerialData(SerialDataTree node, P p); |
| aoqi@0 | 78 | R visitSerialField(SerialFieldTree node, P p); |
| aoqi@0 | 79 | R visitSince(SinceTree node, P p); |
| aoqi@0 | 80 | R visitStartElement(StartElementTree node, P p); |
| aoqi@0 | 81 | R visitText(TextTree node, P p); |
| aoqi@0 | 82 | R visitThrows(ThrowsTree node, P p); |
| aoqi@0 | 83 | R visitUnknownBlockTag(UnknownBlockTagTree node, P p); |
| aoqi@0 | 84 | R visitUnknownInlineTag(UnknownInlineTagTree node, P p); |
| aoqi@0 | 85 | R visitValue(ValueTree node, P p); |
| aoqi@0 | 86 | R visitVersion(VersionTree node, P p); |
| aoqi@0 | 87 | R visitOther(DocTree node, P p); |
| aoqi@0 | 88 | } |
