1 /*
   2  * Copyright (c) 2013, 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 java.io.*;
  29 
  30 import javax.lang.model.element.Element;
  31 import javax.lang.model.element.TypeElement;
  32 
  33 /**
  34  * The interface for writing annotation type field output.
  35  *
  36  *  <p><b>This is NOT part of any supported API.
  37  *  If you write code that depends on this, you do so at your own risk.
  38  *  This code and its internal interfaces are subject to change or
  39  *  deletion without notice.</b>
  40  *
  41  *
  42  * @author Bhavesh Patel
  43  */
  44 
  45 public interface AnnotationTypeFieldWriter {
  46 
  47     /**
  48      * Add the annotation type member tree header.
  49      *
  50      * @return content tree for the member tree header
  51      */
  52     public Content getMemberTreeHeader();
  53 
  54     /**
  55      * Add the annotation type field details marker.
  56      *
  57      * @param memberDetails the content tree representing field details marker
  58      */
  59     public void addAnnotationFieldDetailsMarker(Content memberDetails);
  60 
  61     /**
  62      * Add the annotation type details tree header.
  63      *
  64      * @param typeElement the annotation type being documented
  65      */
  66     public Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
  67 
  68     /**
  69      * Get the annotation type documentation tree header.
  70      *
  71      * @param member the annotation type being documented
  72      * @param annotationDetailsTree the content tree representing annotation type details
  73      * @return content tree for the annotation type documentation header
  74      */
  75     public Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree);
  76 
  77     /**
  78      * Get the annotation type details tree.
  79      *
  80      * @param annotationDetailsTreeHeader the content tree representing annotation type details header
  81      * @param annotationDetailsTree the content tree representing annotation type details
  82      * @return content tree for the annotation type details
  83      */
  84     public Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree);
  85 
  86     /**
  87      * Get the annotation type documentation.
  88      *
  89      * @param annotationDocTree the content tree representing annotation type documentation
  90      * @param isLastContent true if the content to be added is the last content
  91      * @return content tree for the annotation type documentation
  92      */
  93     public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
  94 
  95     /**
  96      * Get the signature for the given member.
  97      *
  98      * @param member the member being documented
  99      * @return content tree for the annotation type signature
 100      */
 101     public Content getSignature(Element member);
 102 
 103     /**
 104      * Add the deprecated output for the given member.
 105      *
 106      * @param member the member being documented
 107      * @param annotationDocTree content tree to which the deprecated information will be added
 108      */
 109     public void addDeprecated(Element member, Content annotationDocTree);
 110 
 111     /**
 112      * Add the comments for the given member.
 113      *
 114      * @param member the member being documented
 115      * @param annotationDocTree the content tree to which the comments will be added
 116      */
 117     public void addComments(Element member, Content annotationDocTree);
 118 
 119     /**
 120      * Add the tags for the given member.
 121      *
 122      * @param member the member being documented
 123      * @param annotationDocTree the content tree to which the tags will be added
 124      */
 125     public void addTags(Element member, Content annotationDocTree);
 126 }