src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java

Tue, 01 Nov 2016 23:55:58 -0700

author
asaha
date
Tue, 01 Nov 2016 23:55:58 -0700
changeset 3339
8efc10efbfe1
parent 2035
a2a5ad0853ed
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8168993: JDK8u121 L10n resource file update
Reviewed-by: coffeys
Contributed-by: li.jiang@oracle.com

duke@1 1 /*
bpatel@2035 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.doclets.internal.toolkit;
duke@1 27
duke@1 28 import java.io.*;
duke@1 29 import com.sun.javadoc.*;
duke@1 30
duke@1 31 /**
duke@1 32 * The interface for writing annotation type required member output.
duke@1 33 *
jjg@1359 34 * <p><b>This is NOT part of any supported API.
jjg@1359 35 * If you write code that depends on this, you do so at your own risk.
jjg@1359 36 * This code and its internal interfaces are subject to change or
jjg@1359 37 * deletion without notice.</b>
jjg@1359 38 *
duke@1 39 *
duke@1 40 * @author Jamie Ho
bpatel@766 41 * @author Bhavesh Patel (Modified)
duke@1 42 * @since 1.5
duke@1 43 */
duke@1 44
duke@1 45 public interface AnnotationTypeRequiredMemberWriter {
duke@1 46
duke@1 47 /**
bpatel@2035 48 * Add the annotation type member tree header.
bpatel@2035 49 *
bpatel@2035 50 * @return content tree for the member tree header
bpatel@2035 51 */
bpatel@2035 52 public Content getMemberTreeHeader();
bpatel@2035 53
bpatel@2035 54 /**
bpatel@2035 55 * Add the annotation type details marker.
bpatel@2035 56 *
bpatel@2035 57 * @param memberDetails the content tree representing details marker
bpatel@2035 58 */
bpatel@2035 59 public void addAnnotationDetailsMarker(Content memberDetails);
bpatel@2035 60
bpatel@2035 61 /**
bpatel@766 62 * Add the annotation type details tree header.
duke@1 63 *
bpatel@766 64 * @param classDoc the annotation type being documented
bpatel@766 65 * @param memberDetailsTree the content tree representing member details
duke@1 66 */
bpatel@766 67 public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,
bpatel@766 68 Content memberDetailsTree);
duke@1 69
duke@1 70 /**
bpatel@766 71 * Get the annotation type documentation tree header.
duke@1 72 *
bpatel@766 73 * @param member the annotation type being documented
bpatel@766 74 * @param annotationDetailsTree the content tree representing annotation type details
bpatel@766 75 * @return content tree for the annotation type documentation header
duke@1 76 */
bpatel@766 77 public Content getAnnotationDocTreeHeader(MemberDoc member,
bpatel@766 78 Content annotationDetailsTree);
duke@1 79
duke@1 80 /**
bpatel@766 81 * Get the annotation type details tree.
duke@1 82 *
bpatel@766 83 * @param annotationDetailsTree the content tree representing annotation type details
bpatel@766 84 * @return content tree for the annotation type details
duke@1 85 */
bpatel@766 86 public Content getAnnotationDetails(Content annotationDetailsTree);
duke@1 87
duke@1 88 /**
bpatel@766 89 * Get the annotation type documentation.
duke@1 90 *
bpatel@766 91 * @param annotationDocTree the content tree representing annotation type documentation
bpatel@766 92 * @param isLastContent true if the content to be added is the last content
bpatel@766 93 * @return content tree for the annotation type documentation
duke@1 94 */
bpatel@766 95 public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
duke@1 96
duke@1 97 /**
bpatel@766 98 * Get the signature for the given member.
duke@1 99 *
bpatel@766 100 * @param member the member being documented
bpatel@766 101 * @return content tree for the annotation type signature
duke@1 102 */
bpatel@766 103 public Content getSignature(MemberDoc member);
duke@1 104
duke@1 105 /**
bpatel@766 106 * Add the deprecated output for the given member.
duke@1 107 *
bpatel@766 108 * @param member the member being documented
bpatel@766 109 * @param annotationDocTree content tree to which the deprecated information will be added
duke@1 110 */
bpatel@766 111 public void addDeprecated(MemberDoc member, Content annotationDocTree);
duke@1 112
duke@1 113 /**
bpatel@766 114 * Add the comments for the given member.
bpatel@766 115 *
bpatel@766 116 * @param member the member being documented
bpatel@766 117 * @param annotationDocTree the content tree to which the comments will be added
duke@1 118 */
bpatel@766 119 public void addComments(MemberDoc member, Content annotationDocTree);
duke@1 120
duke@1 121 /**
bpatel@766 122 * Add the tags for the given member.
duke@1 123 *
bpatel@766 124 * @param member the member being documented
bpatel@766 125 * @param annotationDocTree the content tree to which the tags will be added
duke@1 126 */
bpatel@766 127 public void addTags(MemberDoc member, Content annotationDocTree);
duke@1 128
duke@1 129 /**
duke@1 130 * Close the writer.
duke@1 131 */
duke@1 132 public void close() throws IOException;
duke@1 133 }

mercurial