/*
 * Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.source.doctree;

Common interface for all nodes in a documentation syntax tree.
Since:1.8
/** * Common interface for all nodes in a documentation syntax tree. * * @since 1.8 */
public interface DocTree {
Enumerates all kinds of trees.
/** * Enumerates all kinds of trees. */
enum Kind {
Used for instances of AttributeTree representing an HTML attribute.
/** * Used for instances of {@link AttributeTree} * representing an HTML attribute. */
ATTRIBUTE,
Used for instances of AuthorTree representing an @author tag.
/** * Used for instances of {@link AuthorTree} * representing an @author tag. */
AUTHOR("author"),
Used for instances of LiteralTree representing an @code tag.
/** * Used for instances of {@link LiteralTree} * representing an @code tag. */
CODE("code"),
Used for instances of CommentTree representing an HTML comment.
/** * Used for instances of {@link CommentTree} * representing an HTML comment. */
COMMENT,
Used for instances of DeprecatedTree representing an @deprecated tag.
/** * Used for instances of {@link DeprecatedTree} * representing an @deprecated tag. */
DEPRECATED("deprecated"),
Used for instances of DocCommentTree representing a complete doc comment.
/** * Used for instances of {@link DocCommentTree} * representing a complete doc comment. */
DOC_COMMENT,
Used for instances of DocRootTree representing an @docRoot tag.
/** * Used for instances of {@link DocRootTree} * representing an @docRoot tag. */
DOC_ROOT("docRoot"),
Used for instances of DocTypeTree representing an HTML DocType declaration.
/** * Used for instances of {@link DocTypeTree} * representing an HTML DocType declaration. */
DOC_TYPE,
Used for instances of EndElementTree representing the end of an HTML element.
/** * Used for instances of {@link EndElementTree} * representing the end of an HTML element. */
END_ELEMENT,
Used for instances of EntityTree representing an HTML entity.
/** * Used for instances of {@link EntityTree} * representing an HTML entity. */
ENTITY,
Used for instances of ErroneousTree representing some invalid text.
/** * Used for instances of {@link ErroneousTree} * representing some invalid text. */
ERRONEOUS,
Used for instances of ThrowsTree representing an @exception tag.
/** * Used for instances of {@link ThrowsTree} * representing an @exception tag. */
EXCEPTION("exception"),
Used for instances of HiddenTree representing an @hidden tag.
/** * Used for instances of {@link HiddenTree} * representing an @hidden tag. */
HIDDEN("hidden"),
Used for instances of IdentifierTree representing an identifier.
/** * Used for instances of {@link IdentifierTree} * representing an identifier. */
IDENTIFIER,
Used for instances of IndexTree representing a search term.
/** * Used for instances of {@link IndexTree} * representing a search term. */
INDEX("index"),
Used for instances of InheritDocTree representing an @inheritDoc tag.
/** * Used for instances of {@link InheritDocTree} * representing an @inheritDoc tag. */
INHERIT_DOC("inheritDoc"),
Used for instances of LinkTree representing an @link tag.
/** * Used for instances of {@link LinkTree} * representing an @link tag. */
LINK("link"),
Used for instances of LinkTree representing an @linkplain tag.
/** * Used for instances of {@link LinkTree} * representing an @linkplain tag. */
LINK_PLAIN("linkplain"),
Used for instances of LiteralTree representing an @literal tag.
/** * Used for instances of {@link LiteralTree} * representing an @literal tag. */
LITERAL("literal"),
Used for instances of ParamTree representing an @param tag.
/** * Used for instances of {@link ParamTree} * representing an @param tag. */
PARAM("param"),
Used for instances of ProvidesTree representing an @provides tag.
/** * Used for instances of {@link ProvidesTree} * representing an @provides tag. */
PROVIDES("provides"),
Used for instances of ReferenceTree representing a reference to a element in the Java programming language.
/** * Used for instances of {@link ReferenceTree} * representing a reference to a element in the * Java programming language. */
REFERENCE,
Used for instances of ReturnTree representing an @return tag.
/** * Used for instances of {@link ReturnTree} * representing an @return tag. */
RETURN("return"),
Used for instances of SeeTree representing an @see tag.
/** * Used for instances of {@link SeeTree} * representing an @see tag. */
SEE("see"),
Used for instances of SerialTree representing an @serial tag.
/** * Used for instances of {@link SerialTree} * representing an @serial tag. */
SERIAL("serial"),
Used for instances of SerialDataTree representing an @serialData tag.
/** * Used for instances of {@link SerialDataTree} * representing an @serialData tag. */
SERIAL_DATA("serialData"),
Used for instances of SerialFieldTree representing an @serialField tag.
/** * Used for instances of {@link SerialFieldTree} * representing an @serialField tag. */
SERIAL_FIELD("serialField"),
Used for instances of SinceTree representing an @since tag.
/** * Used for instances of {@link SinceTree} * representing an @since tag. */
SINCE("since"),
Used for instances of EndElementTree representing the start of an HTML element.
/** * Used for instances of {@link EndElementTree} * representing the start of an HTML element. */
START_ELEMENT,
Used for instances of SystemPropertyTree representing an @systemProperty tag.
/** * Used for instances of {@link SystemPropertyTree} * representing an @systemProperty tag. */
SYSTEM_PROPERTY("systemProperty"),
Used for instances of SummaryTree representing the summary of a comment description.
/** * Used for instances of {@link SummaryTree} * representing the summary of a comment description. */
SUMMARY("summary"),
Used for instances of TextTree representing some documentation text.
/** * Used for instances of {@link TextTree} * representing some documentation text. */
TEXT,
Used for instances of ThrowsTree representing an @throws tag.
/** * Used for instances of {@link ThrowsTree} * representing an @throws tag. */
THROWS("throws"),
Used for instances of UnknownBlockTagTree representing an unknown block tag.
/** * Used for instances of {@link UnknownBlockTagTree} * representing an unknown block tag. */
UNKNOWN_BLOCK_TAG,
Used for instances of UnknownInlineTagTree representing an unknown inline tag.
/** * Used for instances of {@link UnknownInlineTagTree} * representing an unknown inline tag. */
UNKNOWN_INLINE_TAG,
Used for instances of UsesTree representing an @uses tag.
/** * Used for instances of {@link UsesTree} * representing an @uses tag. */
USES("uses"),
Used for instances of ValueTree representing an @value tag.
/** * Used for instances of {@link ValueTree} * representing an @value tag. */
VALUE("value"),
Used for instances of VersionTree representing an @version tag.
/** * Used for instances of {@link VersionTree} * representing an @version tag. */
VERSION("version"),
An implementation-reserved node. This is the not the node you are looking for.
/** * An implementation-reserved node. This is the not the node * you are looking for. */
OTHER;
The name of the tag, if any, associated with this kind of node.
/** * The name of the tag, if any, associated with this kind of node. */
public final String tagName; Kind() { tagName = null; } Kind(String tagName) { this.tagName = tagName; } }
Returns the kind of this tree.
Returns:the kind of this tree.
/** * Returns the kind of this tree. * * @return the kind of this tree. */
Kind getKind();
Accept method used to implement the visitor pattern. The visitor pattern is used to implement operations on trees.
Params:
  • visitor – the visitor to be called
  • data – a parameter value to be passed to the visitor method
Type parameters:
  • <R> – result type of this operation.
  • <D> – type of additional data.
Returns:the value returned from the visitor method
/** * Accept method used to implement the visitor pattern. The * visitor pattern is used to implement operations on trees. * * @param <R> result type of this operation. * @param <D> type of additional data. * @param visitor the visitor to be called * @param data a parameter value to be passed to the visitor method * @return the value returned from the visitor method */
<R, D> R accept(DocTreeVisitor<R,D> visitor, D data); }