1 /*
   2  * Copyright (c) 2003, 2016, 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 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.
  48      *
  49      * @param typeElement the class being documented
  50      * @param memberDetailsTree the content tree representing member details
  51      * @return content tree for the field details header
  52      */
  53     public Content getFieldDetailsTreeHeader(TypeElement typeElement,
  54             Content memberDetailsTree);
  55 
  56     /**
  57      * Get the field documentation tree header.
  58      *
  59      * @param field the constructor being documented
  60      * @param fieldDetailsTree the content tree representing field details
  61      * @return content tree for the field documentation header
  62      */
  63     public Content getFieldDocTreeHeader(VariableElement field,
  64             Content fieldDetailsTree);
  65 
  66     /**
  67      * Get the signature for the given field.
  68      *
  69      * @param field the field being documented
  70      * @return content tree for the field signature
  71      */
  72     public Content getSignature(VariableElement field);
  73 
  74     /**
  75      * Add the deprecated output for the given field.
  76      *
  77      * @param field the field being documented
  78      * @param fieldDocTree content tree to which the deprecated information will be added
  79      */
  80     public void addDeprecated(VariableElement field, Content fieldDocTree);
  81 
  82     /**
  83      * Add the comments for the given field.
  84      *
  85      * @param field the field being documented
  86      * @param fieldDocTree the content tree to which the comments will be added
  87      */
  88     public void addComments(VariableElement field, Content fieldDocTree);
  89 
  90     /**
  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 }