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 
  26 package com.sun.source.doctree;
  27 
  28 import java.util.ArrayList;
  29 import java.util.List;
  30 
  31 /**
  32  * The top level representation of a documentation comment.
  33  *
  34  * <p>
  35  * first-sentence body block-tags
  36  *
  37  * @since 1.8
  38  */
  39 @jdk.Exported
  40 public interface DocCommentTree extends DocTree {
  41     /**
  42      * Returns the first sentence of a documentation comment.
  43      * @return the first sentence of a documentation comment
  44      */
  45     List<? extends DocTree> getFirstSentence();
  46 
  47     /**
  48      * Returns the entire body of a documentation comment, appearing
  49      * before any block tags, including the first sentence.
  50      * @return body of a documentation comment first sentence inclusive
  51      *
  52      * @since 9
  53      */
  54     default List<? extends DocTree> getFullBody() {
  55         ArrayList<DocTree> bodyList = new ArrayList<>();
  56         bodyList.addAll(getFirstSentence());
  57         bodyList.addAll(getBody());
  58         return bodyList;
  59     }
  60 
  61     /**
  62      * Returns the body of a documentation comment,
  63      * appearing after the first sentence, and before any block tags.
  64      * @return the body of a documentation comment
  65      */
  66     List<? extends DocTree> getBody();
  67 
  68     /**
  69      * Returns the block tags for a documentation comment.
  70      * @return the block tags of a documentation comment
  71      */
  72     List<? extends DocTree> getBlockTags();
  73 }