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

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 766
90af8d87741f
child 1359
25e14ad23cef
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

duke@1 1 /*
ohair@798 2 * Copyright (c) 2003, 2010, 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 *
duke@1 34 * This code is not part of an API.
duke@1 35 * It is implementation that is subject to change.
duke@1 36 * Do not use it as an API
duke@1 37 *
duke@1 38 * @author Jamie Ho
bpatel@766 39 * @author Bhavesh Patel (Modified)
duke@1 40 * @since 1.5
duke@1 41 */
duke@1 42
duke@1 43 public interface AnnotationTypeRequiredMemberWriter {
duke@1 44
duke@1 45 /**
bpatel@766 46 * Add the annotation type details tree header.
duke@1 47 *
bpatel@766 48 * @param classDoc the annotation type being documented
bpatel@766 49 * @param memberDetailsTree the content tree representing member details
duke@1 50 */
bpatel@766 51 public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,
bpatel@766 52 Content memberDetailsTree);
duke@1 53
duke@1 54 /**
bpatel@766 55 * Get the annotation type documentation tree header.
duke@1 56 *
bpatel@766 57 * @param member the annotation type being documented
bpatel@766 58 * @param annotationDetailsTree the content tree representing annotation type details
bpatel@766 59 * @return content tree for the annotation type documentation header
duke@1 60 */
bpatel@766 61 public Content getAnnotationDocTreeHeader(MemberDoc member,
bpatel@766 62 Content annotationDetailsTree);
duke@1 63
duke@1 64 /**
bpatel@766 65 * Get the annotation type details tree.
duke@1 66 *
bpatel@766 67 * @param annotationDetailsTree the content tree representing annotation type details
bpatel@766 68 * @return content tree for the annotation type details
duke@1 69 */
bpatel@766 70 public Content getAnnotationDetails(Content annotationDetailsTree);
duke@1 71
duke@1 72 /**
bpatel@766 73 * Get the annotation type documentation.
duke@1 74 *
bpatel@766 75 * @param annotationDocTree the content tree representing annotation type documentation
bpatel@766 76 * @param isLastContent true if the content to be added is the last content
bpatel@766 77 * @return content tree for the annotation type documentation
duke@1 78 */
bpatel@766 79 public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
duke@1 80
duke@1 81 /**
bpatel@766 82 * Get the signature for the given member.
duke@1 83 *
bpatel@766 84 * @param member the member being documented
bpatel@766 85 * @return content tree for the annotation type signature
duke@1 86 */
bpatel@766 87 public Content getSignature(MemberDoc member);
duke@1 88
duke@1 89 /**
bpatel@766 90 * Add the deprecated output for the given member.
duke@1 91 *
bpatel@766 92 * @param member the member being documented
bpatel@766 93 * @param annotationDocTree content tree to which the deprecated information will be added
duke@1 94 */
bpatel@766 95 public void addDeprecated(MemberDoc member, Content annotationDocTree);
duke@1 96
duke@1 97 /**
bpatel@766 98 * Add the comments for the given member.
bpatel@766 99 *
bpatel@766 100 * @param member the member being documented
bpatel@766 101 * @param annotationDocTree the content tree to which the comments will be added
duke@1 102 */
bpatel@766 103 public void addComments(MemberDoc member, Content annotationDocTree);
duke@1 104
duke@1 105 /**
bpatel@766 106 * Add the tags for the given member.
duke@1 107 *
bpatel@766 108 * @param member the member being documented
bpatel@766 109 * @param annotationDocTree the content tree to which the tags will be added
duke@1 110 */
bpatel@766 111 public void addTags(MemberDoc member, Content annotationDocTree);
duke@1 112
duke@1 113 /**
duke@1 114 * Close the writer.
duke@1 115 */
duke@1 116 public void close() throws IOException;
duke@1 117 }

mercurial