< prev index next >

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/FieldWriter.java

Print this page




   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 jdk.javadoc.internal.doclets.toolkit;
  27 


  28 import javax.lang.model.element.TypeElement;
  29 import javax.lang.model.element.VariableElement;
  30 
  31 
  32 /**
  33  * The interface for writing field output.
  34  *
  35  *  <p><b>This is NOT part of any supported API.
  36  *  If you write code that depends on this, you do so at your own risk.
  37  *  This code and its internal interfaces are subject to change or
  38  *  deletion without notice.</b>
  39  *
  40  * @author Jamie Ho
  41  * @author Bhavesh Patel (Modified)
  42  */
  43 
  44 public interface FieldWriter {
  45 
  46     /**
  47      * Get the field details tree header.


  91      * Add the tags for the given field.
  92      *
  93      * @param field the field being documented
  94      * @param fieldDocTree the content tree to which the tags will be added
  95      */
  96     public void addTags(VariableElement field, Content fieldDocTree);
  97 
  98     /**
  99      * Get the field details tree.
 100      *
 101      * @param memberDetailsTreeHeader the content tree representing member details tree header
 102      * @param memberDetailsTree the content tree representing member details
 103      * @return content tree for the field details
 104      */
 105     public Content getFieldDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
 106 
 107     /**
 108      * Get the field documentation.
 109      *
 110      * @param fieldDocTree the content tree representing field documentation

 111      * @return content tree for the field documentation
 112      */
 113     public Content getFieldDoc(Content fieldDocTree);
 114 
 115     /**
 116      * Gets the member header tree.
 117      *
 118      * @return a content tree for the member header
 119      */
 120     public Content getMemberTreeHeader();
 121 }


   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 jdk.javadoc.internal.doclets.toolkit;
  27 
  28 import java.io.*;
  29 
  30 import javax.lang.model.element.TypeElement;
  31 import javax.lang.model.element.VariableElement;
  32 
  33 
  34 /**
  35  * The interface for writing field output.
  36  *
  37  *  <p><b>This is NOT part of any supported API.
  38  *  If you write code that depends on this, you do so at your own risk.
  39  *  This code and its internal interfaces are subject to change or
  40  *  deletion without notice.</b>
  41  *
  42  * @author Jamie Ho
  43  * @author Bhavesh Patel (Modified)
  44  */
  45 
  46 public interface FieldWriter {
  47 
  48     /**
  49      * Get the field details tree header.


  93      * Add the tags for the given field.
  94      *
  95      * @param field the field being documented
  96      * @param fieldDocTree the content tree to which the tags will be added
  97      */
  98     public void addTags(VariableElement field, Content fieldDocTree);
  99 
 100     /**
 101      * Get the field details tree.
 102      *
 103      * @param memberDetailsTreeHeader the content tree representing member details tree header
 104      * @param memberDetailsTree the content tree representing member details
 105      * @return content tree for the field details
 106      */
 107     public Content getFieldDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
 108 
 109     /**
 110      * Get the field documentation.
 111      *
 112      * @param fieldDocTree the content tree representing field documentation
 113      * @param isLastContent true if the content to be added is the last content
 114      * @return content tree for the field documentation
 115      */
 116     public Content getFieldDoc(Content fieldDocTree, boolean isLastContent);
 117 
 118     /**
 119      * Gets the member header tree.
 120      *
 121      * @return a content tree for the member header
 122      */
 123     public Content getMemberTreeHeader();
 124 }
< prev index next >