jdk-sandbox: langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.java@cfadc977ca75 (annotated)

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

author	bpatel
	Wed, 01 Dec 2010 11:02:38 -0800
changeset 7614	cfadc977ca75
parent 5520	86e4b9a9da40
child 7681	1f0819a3341f
permissions	-rw-r--r--