1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeRequiredMemberWriter.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,133 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit;
1.30 +
1.31 +import java.io.*;
1.32 +import com.sun.javadoc.*;
1.33 +
1.34 +/**
1.35 + * The interface for writing annotation type required member output.
1.36 + *
1.37 + * <p><b>This is NOT part of any supported API.
1.38 + * If you write code that depends on this, you do so at your own risk.
1.39 + * This code and its internal interfaces are subject to change or
1.40 + * deletion without notice.</b>
1.41 + *
1.42 + *
1.43 + * @author Jamie Ho
1.44 + * @author Bhavesh Patel (Modified)
1.45 + * @since 1.5
1.46 + */
1.47 +
1.48 +public interface AnnotationTypeRequiredMemberWriter {
1.49 +
1.50 + /**
1.51 + * Add the annotation type member tree header.
1.52 + *
1.53 + * @return content tree for the member tree header
1.54 + */
1.55 + public Content getMemberTreeHeader();
1.56 +
1.57 + /**
1.58 + * Add the annotation type details marker.
1.59 + *
1.60 + * @param memberDetails the content tree representing details marker
1.61 + */
1.62 + public void addAnnotationDetailsMarker(Content memberDetails);
1.63 +
1.64 + /**
1.65 + * Add the annotation type details tree header.
1.66 + *
1.67 + * @param classDoc the annotation type being documented
1.68 + * @param memberDetailsTree the content tree representing member details
1.69 + */
1.70 + public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,
1.71 + Content memberDetailsTree);
1.72 +
1.73 + /**
1.74 + * Get the annotation type documentation tree header.
1.75 + *
1.76 + * @param member the annotation type being documented
1.77 + * @param annotationDetailsTree the content tree representing annotation type details
1.78 + * @return content tree for the annotation type documentation header
1.79 + */
1.80 + public Content getAnnotationDocTreeHeader(MemberDoc member,
1.81 + Content annotationDetailsTree);
1.82 +
1.83 + /**
1.84 + * Get the annotation type details tree.
1.85 + *
1.86 + * @param annotationDetailsTree the content tree representing annotation type details
1.87 + * @return content tree for the annotation type details
1.88 + */
1.89 + public Content getAnnotationDetails(Content annotationDetailsTree);
1.90 +
1.91 + /**
1.92 + * Get the annotation type documentation.
1.93 + *
1.94 + * @param annotationDocTree the content tree representing annotation type documentation
1.95 + * @param isLastContent true if the content to be added is the last content
1.96 + * @return content tree for the annotation type documentation
1.97 + */
1.98 + public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
1.99 +
1.100 + /**
1.101 + * Get the signature for the given member.
1.102 + *
1.103 + * @param member the member being documented
1.104 + * @return content tree for the annotation type signature
1.105 + */
1.106 + public Content getSignature(MemberDoc member);
1.107 +
1.108 + /**
1.109 + * Add the deprecated output for the given member.
1.110 + *
1.111 + * @param member the member being documented
1.112 + * @param annotationDocTree content tree to which the deprecated information will be added
1.113 + */
1.114 + public void addDeprecated(MemberDoc member, Content annotationDocTree);
1.115 +
1.116 + /**
1.117 + * Add the comments for the given member.
1.118 + *
1.119 + * @param member the member being documented
1.120 + * @param annotationDocTree the content tree to which the comments will be added
1.121 + */
1.122 + public void addComments(MemberDoc member, Content annotationDocTree);
1.123 +
1.124 + /**
1.125 + * Add the tags for the given member.
1.126 + *
1.127 + * @param member the member being documented
1.128 + * @param annotationDocTree the content tree to which the tags will be added
1.129 + */
1.130 + public void addTags(MemberDoc member, Content annotationDocTree);
1.131 +
1.132 + /**
1.133 + * Close the writer.
1.134 + */
1.135 + public void close() throws IOException;
1.136 +}
