Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.java@959103a6100f (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.java
Wed, 27 Apr 2016 01:34:52 +0800
- author
- aoqi
- date
- Wed, 27 Apr 2016 01:34:52 +0800
- changeset 0
- 959103a6100f
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | |
| aoqi@0 | 27 | package com.sun.tools.doclets.internal.toolkit; |
| aoqi@0 | 28 | |
| aoqi@0 | 29 | import java.io.*; |
| aoqi@0 | 30 | import com.sun.javadoc.*; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * The interface for writing annotation type output. |
| aoqi@0 | 34 | * |
| aoqi@0 | 35 | * <p><b>This is NOT part of any supported API. |
| aoqi@0 | 36 | * If you write code that depends on this, you do so at your own risk. |
| aoqi@0 | 37 | * This code and its internal interfaces are subject to change or |
| aoqi@0 | 38 | * deletion without notice.</b> |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * @author Jamie Ho |
| aoqi@0 | 41 | * @author Bhavesh Patel (Modified) |
| aoqi@0 | 42 | * @since 1.5 |
| aoqi@0 | 43 | */ |
| aoqi@0 | 44 | |
| aoqi@0 | 45 | public interface AnnotationTypeWriter { |
| aoqi@0 | 46 | |
| aoqi@0 | 47 | /** |
| aoqi@0 | 48 | * Get the header of the page. |
| aoqi@0 | 49 | * |
| aoqi@0 | 50 | * @param header the header string to write |
| aoqi@0 | 51 | * @return a content tree for the header documentation |
| aoqi@0 | 52 | */ |
| aoqi@0 | 53 | public Content getHeader(String header); |
| aoqi@0 | 54 | |
| aoqi@0 | 55 | /** |
| aoqi@0 | 56 | * Get the annotation content header. |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * @return annotation content header that needs to be added to the documentation |
| aoqi@0 | 59 | */ |
| aoqi@0 | 60 | public Content getAnnotationContentHeader(); |
| aoqi@0 | 61 | |
| aoqi@0 | 62 | /** |
| aoqi@0 | 63 | * Get the annotation information tree header. |
| aoqi@0 | 64 | * |
| aoqi@0 | 65 | * @return annotation information tree header that needs to be added to the documentation |
| aoqi@0 | 66 | */ |
| aoqi@0 | 67 | public Content getAnnotationInfoTreeHeader(); |
| aoqi@0 | 68 | |
| aoqi@0 | 69 | /** |
| aoqi@0 | 70 | * Get the annotation information. |
| aoqi@0 | 71 | * |
| aoqi@0 | 72 | * @param annotationInfoTree content tree containing the annotation information |
| aoqi@0 | 73 | * @return a content tree for the annotation |
| aoqi@0 | 74 | */ |
| aoqi@0 | 75 | public Content getAnnotationInfo(Content annotationInfoTree); |
| aoqi@0 | 76 | |
| aoqi@0 | 77 | /** |
| aoqi@0 | 78 | * Add the signature of the current annotation type. |
| aoqi@0 | 79 | * |
| aoqi@0 | 80 | * @param modifiers the modifiers for the signature |
| aoqi@0 | 81 | * @param annotationInfoTree the annotation content tree to which the signature will be added |
| aoqi@0 | 82 | */ |
| aoqi@0 | 83 | public void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree); |
| aoqi@0 | 84 | |
| aoqi@0 | 85 | /** |
| aoqi@0 | 86 | * Build the annotation type description. |
| aoqi@0 | 87 | * |
| aoqi@0 | 88 | * @param annotationInfoTree content tree to which the description will be added |
| aoqi@0 | 89 | */ |
| aoqi@0 | 90 | public void addAnnotationTypeDescription(Content annotationInfoTree); |
| aoqi@0 | 91 | |
| aoqi@0 | 92 | /** |
| aoqi@0 | 93 | * Add the tag information for the current annotation type. |
| aoqi@0 | 94 | * |
| aoqi@0 | 95 | * @param annotationInfoTree content tree to which the tag information will be added |
| aoqi@0 | 96 | */ |
| aoqi@0 | 97 | public void addAnnotationTypeTagInfo(Content annotationInfoTree); |
| aoqi@0 | 98 | |
| aoqi@0 | 99 | /** |
| aoqi@0 | 100 | * If this annotation is deprecated, add the appropriate information. |
| aoqi@0 | 101 | * |
| aoqi@0 | 102 | * @param annotationInfoTree content tree to which the deprecated information will be added |
| aoqi@0 | 103 | */ |
| aoqi@0 | 104 | public void addAnnotationTypeDeprecationInfo (Content annotationInfoTree); |
| aoqi@0 | 105 | |
| aoqi@0 | 106 | /** |
| aoqi@0 | 107 | * Get the member tree header for the annotation type. |
| aoqi@0 | 108 | * |
| aoqi@0 | 109 | * @return a content tree for the member tree header |
| aoqi@0 | 110 | */ |
| aoqi@0 | 111 | public Content getMemberTreeHeader(); |
| aoqi@0 | 112 | |
| aoqi@0 | 113 | /** |
| aoqi@0 | 114 | * Get the member tree. |
| aoqi@0 | 115 | * |
| aoqi@0 | 116 | * @param memberTree the content tree that will be modified and returned |
| aoqi@0 | 117 | * @return a content tree for the member |
| aoqi@0 | 118 | */ |
| aoqi@0 | 119 | public Content getMemberTree(Content memberTree); |
| aoqi@0 | 120 | |
| aoqi@0 | 121 | /** |
| aoqi@0 | 122 | * Get the member summary tree. |
| aoqi@0 | 123 | * |
| aoqi@0 | 124 | * @param memberTree the content tree that will be used to build the summary tree |
| aoqi@0 | 125 | * @return a content tree for the member summary |
| aoqi@0 | 126 | */ |
| aoqi@0 | 127 | public Content getMemberSummaryTree(Content memberTree); |
| aoqi@0 | 128 | |
| aoqi@0 | 129 | /** |
| aoqi@0 | 130 | * Get the member details tree. |
| aoqi@0 | 131 | * |
| aoqi@0 | 132 | * @param memberTree the content tree that will be used to build the details tree |
| aoqi@0 | 133 | * @return a content tree for the member details |
| aoqi@0 | 134 | */ |
| aoqi@0 | 135 | public Content getMemberDetailsTree(Content memberTree); |
| aoqi@0 | 136 | |
| aoqi@0 | 137 | /** |
| aoqi@0 | 138 | * Add the footer of the page. |
| aoqi@0 | 139 | * |
| aoqi@0 | 140 | * @param contentTree content tree to which the footer will be added |
| aoqi@0 | 141 | */ |
| aoqi@0 | 142 | public void addFooter(Content contentTree); |
| aoqi@0 | 143 | |
| aoqi@0 | 144 | /** |
| aoqi@0 | 145 | * Print the document. |
| aoqi@0 | 146 | * |
| aoqi@0 | 147 | * @param contentTree content tree that will be printed as a document |
| aoqi@0 | 148 | */ |
| aoqi@0 | 149 | public void printDocument(Content contentTree) throws IOException; |
| aoqi@0 | 150 | |
| aoqi@0 | 151 | /** |
| aoqi@0 | 152 | * Close the writer. |
| aoqi@0 | 153 | */ |
| aoqi@0 | 154 | public void close() throws IOException; |
| aoqi@0 | 155 | |
| aoqi@0 | 156 | /** |
| aoqi@0 | 157 | * Return the {@link AnnotationTypeDoc} being documented. |
| aoqi@0 | 158 | * |
| aoqi@0 | 159 | * @return the AnnotationTypeDoc being documented. |
| aoqi@0 | 160 | */ |
| aoqi@0 | 161 | public AnnotationTypeDoc getAnnotationTypeDoc(); |
| aoqi@0 | 162 | } |
