1 /* 2 * Copyright (c) 2013, 2019, 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 field 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 public interface AnnotationTypeFieldWriter { 41 42 /** 43 * Add the annotation type member tree header. 44 * 45 * @return content tree for the member tree header 46 */ 47 Content getMemberTreeHeader(); 48 49 /** 50 * Add the annotation type field details marker. 51 * 52 * @param memberDetails the content tree representing field details marker 53 */ 54 void addAnnotationFieldDetailsMarker(Content memberDetails); 55 56 /** 57 * Add the annotation type details tree header. 58 * 59 * @return content tree for the annotation details header 60 */ 61 Content getAnnotationDetailsTreeHeader(); 62 63 /** 64 * Get the annotation type documentation tree header. 65 * 66 * @param member the annotation type being documented 67 * @return content tree for the annotation type documentation header 68 */ 69 Content getAnnotationDocTreeHeader(Element member); 70 71 /** 72 * Get the annotation type details tree. 73 * 74 * @param annotationDetailsTreeHeader the content tree representing annotation type details header 75 * @param annotationDetailsTree the content tree representing annotation type details 76 * @return content tree for the annotation type details 77 */ 78 Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree); 79 80 /** 81 * Get the annotation type documentation. 82 * 83 * @param annotationDocTree the content tree representing annotation type documentation 84 * @return content tree for the annotation type documentation 85 */ 86 Content getAnnotationDoc(Content annotationDocTree); 87 88 /** 89 * Get the signature for the given member. 90 * 91 * @param member the member being documented 92 * @return content tree for the annotation type signature 93 */ 94 Content getSignature(Element member); 95 96 /** 97 * Add the deprecated output for the given member. 98 * 99 * @param member the member being documented 100 * @param annotationDocTree content tree to which the deprecated information will be added 101 */ 102 void addDeprecated(Element member, Content annotationDocTree); 103 104 /** 105 * Add the comments for the given member. 106 * 107 * @param member the member being documented 108 * @param annotationDocTree the content tree to which the comments will be added 109 */ 110 void addComments(Element member, Content annotationDocTree); 111 112 /** 113 * Add the tags for the given member. 114 * 115 * @param member the member being documented 116 * @param annotationDocTree the content tree to which the tags will be added 117 */ 118 void addTags(Element member, Content annotationDocTree); 119 }