• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java@93012e2a5d1d (annotated)

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

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 3938

93012e2a5d1d

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2012, 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 class 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 ClassWriter {
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 header content that needs to be added to the documentation
aoqi@0	52	*/
aoqi@0	53	public Content getHeader(String header);
aoqi@0	54
aoqi@0	55	/**
aoqi@0	56	* Get the class content header.
aoqi@0	57	*
aoqi@0	58	* @return class content header that needs to be added to the documentation
aoqi@0	59	*/
aoqi@0	60	public Content getClassContentHeader();
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Add the class tree documentation.
aoqi@0	64	*
aoqi@0	65	* @param classContentTree class content tree to which the documentation will be added
aoqi@0	66	*/
aoqi@0	67	public void addClassTree(Content classContentTree);
aoqi@0	68
aoqi@0	69	/**
aoqi@0	70	* Get the class information tree header.
aoqi@0	71	*
aoqi@0	72	* @return class informaion tree header that needs to be added to the documentation
aoqi@0	73	*/
aoqi@0	74	public Content getClassInfoTreeHeader();
aoqi@0	75
aoqi@0	76	/**
aoqi@0	77	* Add the type parameter information.
aoqi@0	78	*
aoqi@0	79	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	80	*/
aoqi@0	81	public void addTypeParamInfo(Content classInfoTree);
aoqi@0	82
aoqi@0	83	/**
aoqi@0	84	* Add all super interfaces if this is an interface.
aoqi@0	85	*
aoqi@0	86	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	87	*/
aoqi@0	88	public void addSuperInterfacesInfo(Content classInfoTree);
aoqi@0	89
aoqi@0	90	/**
aoqi@0	91	* Add all implemented interfaces if this is a class.
aoqi@0	92	*
aoqi@0	93	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	94	*/
aoqi@0	95	public void addImplementedInterfacesInfo(Content classInfoTree);
aoqi@0	96
aoqi@0	97	/**
aoqi@0	98	* Add all the classes that extend this one.
aoqi@0	99	*
aoqi@0	100	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	101	*/
aoqi@0	102	public void addSubClassInfo(Content classInfoTree);
aoqi@0	103
aoqi@0	104	/**
aoqi@0	105	* Add all the interfaces that extend this one.
aoqi@0	106	*
aoqi@0	107	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	108	*/
aoqi@0	109	public void addSubInterfacesInfo(Content classInfoTree);
aoqi@0	110
aoqi@0	111	/**
aoqi@0	112	* If this is an interface, add all classes that implement this
aoqi@0	113	* interface.
aoqi@0	114	*
aoqi@0	115	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	116	*/
aoqi@0	117	public void addInterfaceUsageInfo(Content classInfoTree);
aoqi@0	118
aoqi@0	119	/**
aoqi@0	120	* If this is an functional interface, display appropriate message.
aoqi@0	121	*
aoqi@0	122	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	123	*/
aoqi@0	124	public void addFunctionalInterfaceInfo(Content classInfoTree);
aoqi@0	125
aoqi@0	126	/**
aoqi@0	127	* If this is an inner class or interface, add the enclosing class or
aoqi@0	128	* interface.
aoqi@0	129	*
aoqi@0	130	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	131	*/
aoqi@0	132	public void addNestedClassInfo (Content classInfoTree);
aoqi@0	133
aoqi@0	134	/**
aoqi@0	135	* Get the class information.
aoqi@0	136	*
aoqi@0	137	* @param classInfoTree content tree conatining the class information
aoqi@0	138	* @return a content tree for the class
aoqi@0	139	*/
aoqi@0	140	public Content getClassInfo(Content classInfoTree);
aoqi@0	141
aoqi@0	142	/**
aoqi@0	143	* If this class is deprecated, add the appropriate information.
aoqi@0	144	*
aoqi@0	145	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	146	*/
aoqi@0	147	public void addClassDeprecationInfo (Content classInfoTree);
aoqi@0	148
aoqi@0	149	/**
aoqi@0	150	* Add the signature of the current class content tree.
aoqi@0	151	*
aoqi@0	152	* @param modifiers the modifiers for the signature
aoqi@0	153	* @param classInfoTree the class content tree to which the signature will be added
aoqi@0	154	*/
aoqi@0	155	public void addClassSignature(String modifiers, Content classInfoTree);
aoqi@0	156
aoqi@0	157	/**
aoqi@0	158	* Build the class description.
aoqi@0	159	*
aoqi@0	160	* @param classInfoTree content tree to which the documentation will be added
aoqi@0	161	*/
aoqi@0	162	public void addClassDescription(Content classInfoTree);
aoqi@0	163
aoqi@0	164	/**
aoqi@0	165	* Add the tag information for the current class.
aoqi@0	166	*
aoqi@0	167	* @param classInfoTree content tree to which the tag information will be added
aoqi@0	168	*/
aoqi@0	169	public void addClassTagInfo(Content classInfoTree);
aoqi@0	170
aoqi@0	171	/**
aoqi@0	172	* Get the member tree header for the class.
aoqi@0	173	*
aoqi@0	174	* @return a content tree for the member tree header
aoqi@0	175	*/
aoqi@0	176	public Content getMemberTreeHeader();
aoqi@0	177
aoqi@0	178	/**
aoqi@0	179	* Add the footer of the page.
aoqi@0	180	*
aoqi@0	181	* @param contentTree content tree to which the footer will be added
aoqi@0	182	*/
aoqi@0	183	public void addFooter(Content contentTree);
aoqi@0	184
aoqi@0	185	/**
aoqi@0	186	* Print the document.
aoqi@0	187	*
aoqi@0	188	* @param contentTree content tree that will be printed as a document
aoqi@0	189	*/
aoqi@0	190	public void printDocument(Content contentTree) throws IOException;
aoqi@0	191
aoqi@0	192	/**
aoqi@0	193	* Close the writer.
aoqi@0	194	*/
aoqi@0	195	public void close() throws IOException;
aoqi@0	196
aoqi@0	197	/**
aoqi@0	198	* Return the classDoc being documented.
aoqi@0	199	*
aoqi@0	200	* @return the classDoc being documented.
aoqi@0	201	*/
aoqi@0	202	public ClassDoc getClassDoc();
aoqi@0	203
aoqi@0	204	/**
aoqi@0	205	* Get the member summary tree.
aoqi@0	206	*
aoqi@0	207	* @param memberTree the content tree used to build the summary tree
aoqi@0	208	* @return a content tree for the member summary
aoqi@0	209	*/
aoqi@0	210	public Content getMemberSummaryTree(Content memberTree);
aoqi@0	211
aoqi@0	212	/**
aoqi@0	213	* Get the member details tree.
aoqi@0	214	*
aoqi@0	215	* @param memberTree the content tree used to build the details tree
aoqi@0	216	* @return a content tree for the member details
aoqi@0	217	*/
aoqi@0	218	public Content getMemberDetailsTree(Content memberTree);
aoqi@0	219	}