1 /*
   2  * Copyright (c) 2003, 2017, 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.Element;
  29 import javax.lang.model.element.TypeElement;
  30 
  31 /**
  32  * The interface for writing annotation type required member output.
  33  *
  34  *  <p><b>This is NOT part of any supported API.
  35  *  If you write code that depends on this, you do so at your own risk.
  36  *  This code and its internal interfaces are subject to change or
  37  *  deletion without notice.</b>
  38  *
  39  *
  40  * @author Jamie Ho
  41  * @author Bhavesh Patel (Modified)
  42  */
  43 
  44 public interface AnnotationTypeRequiredMemberWriter {
  45 
  46     /**
  47      * Add the annotation type member tree header.
  48      *
  49      * @return content tree for the member tree header
  50      */
  51     public Content getMemberTreeHeader();
  52 
  53     /**
  54      * Add the annotation type details marker.
  55      *
  56      * @param memberDetails the content tree representing details marker
  57      */
  58     public void addAnnotationDetailsMarker(Content memberDetails);
  59 
  60     /**
  61      * Add the annotation type details tree header.
  62      *
  63      * @param typeElement the annotation type being documented
  64      */
  65     public Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
  66 
  67     /**
  68      * Get the annotation type documentation tree header.
  69      *
  70      * @param member the annotation type being documented
  71      * @param annotationDetailsTree the content tree representing annotation type details
  72      * @return content tree for the annotation type documentation header
  73      */
  74     public Content getAnnotationDocTreeHeader(Element member,
  75             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 }