Mercurial > jdk8-mips64-public > langtools / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/tools/javac/tree/DocCommentTable.java	Wed Apr 27 01:34:52 2016 +0800
     1.3 @@ -0,0 +1,66 @@
     1.4 +/*
     1.5 + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +package com.sun.tools.javac.tree;
    1.29 +
    1.30 +import com.sun.source.doctree.ErroneousTree;
    1.31 +import com.sun.tools.javac.parser.Tokens.Comment;
    1.32 +import com.sun.tools.javac.tree.DCTree.DCDocComment;
    1.33 +
    1.34 +/**
    1.35 + * A table giving the doc comment, if any, for any tree node.
    1.36 + *
    1.37 + *  <p><b>This is NOT part of any supported API.
    1.38 + *  If you write code that depends on this, you do so at your own
    1.39 + *  risk.  This code and its internal interfaces are subject to change
    1.40 + *  or deletion without notice.</b>
    1.41 + */
    1.42 +public interface DocCommentTable {
    1.43 +    /**
    1.44 +     * Check if a tree node has a corresponding doc comment.
    1.45 +     */
    1.46 +    public boolean hasComment(JCTree tree);
    1.47 +
    1.48 +    /**
    1.49 +     * Get the Comment token containing the doc comment, if any, for a tree node.
    1.50 +     */
    1.51 +    public Comment getComment(JCTree tree);
    1.52 +
    1.53 +    /**
    1.54 +     * Get the plain text of the doc comment, if any, for a tree node.
    1.55 +     */
    1.56 +    public String getCommentText(JCTree tree);
    1.57 +
    1.58 +    /**
    1.59 +     * Get the parsed form of the doc comment as a DocTree. If any errors
    1.60 +     * are detected during parsing, they will be reported via
    1.61 +     * {@link ErroneousTree ErroneousTree} nodes within the resulting tree.
    1.62 +     */
    1.63 +    public DCDocComment getCommentTree(JCTree tree);
    1.64 +
    1.65 +    /**
    1.66 +     * Set the Comment to be associated with a tree node.
    1.67 +     */
    1.68 +    public void putComment(JCTree tree, Comment c);
    1.69 +}