jdk-sandbox: langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/DocType.java@4e8e488eeae0 (annotated)

7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	1	/*
14260 727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	2	* Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	4	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	5	* This code is free software; you can redistribute it and/or modify it
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	6	* under the terms of the GNU General Public License version 2 only, as
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	7	* published by the Free Software Foundation. Oracle designates this
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	8	* particular file as subject to the "Classpath" exception as provided
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	9	* by Oracle in the LICENSE file that accompanied this code.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	10	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	11	* This code is distributed in the hope that it will be useful, but WITHOUT
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	14	* version 2 for more details (a copy is included in the LICENSE file that
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	15	* accompanied this code).
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	16	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	17	* You should have received a copy of the GNU General Public License version
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	18	* 2 along with this work; if not, write to the Free Software Foundation,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	20	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	22	* or visit www.oracle.com if you need additional information or have any
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	23	* questions.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	24	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	25
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	26	package com.sun.tools.doclets.formats.html.markup;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	27
14265 4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	28	import java.io.IOException;
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	29	import java.io.Writer;
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	30
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	31	import com.sun.tools.doclets.internal.toolkit.Content;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	32	import com.sun.tools.doclets.internal.toolkit.util.*;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	33
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	34	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	35	* Class for generating document type for HTML pages of javadoc output.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	36	*
14260 727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	37	* <p><b>This is NOT part of any supported API.
727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	38	* If you write code that depends on this, you do so at your own risk.
727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	39	* This code and its internal interfaces are subject to change or
727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	40	* deletion without notice.</b>
727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	41	*
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	42	* @author Bhavesh Patel
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	43	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	44	public class DocType extends Content{
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	45
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	46	private String docType;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	47
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	48	private static DocType transitional;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	49
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	50	private static DocType frameset;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	51
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	52	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	53	* Constructor to construct a DocType object.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	54	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	55	* @param type the doctype to be added
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	56	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	57	private DocType(String type, String dtd) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	58	docType = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 " + type +
7641 8b552db25f99 7006270: Several javadoc regression tests are failing on windows bpatel parents: 7614 diff changeset	59	"//EN\" \"" + dtd + "\">" + DocletConstants.NL;
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	60	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	61
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	62	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	63	* Construct and return a HTML 4.01 transitional DocType content
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	64	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	65	* @return a content tree for transitional DocType
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	66	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	67	public static DocType Transitional() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	68	if (transitional == null)
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	69	transitional = new DocType("Transitional", "http://www.w3.org/TR/html4/loose.dtd");
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	70	return transitional;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	71	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	72
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	73	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	74	* Construct and return a HTML 4.01 frameset DocType content
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	75	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	76	* @return a content tree for frameset DocType
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	77	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	78	public static DocType Frameset() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	79	if (frameset == null)
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	80	frameset = new DocType("Frameset", "http://www.w3.org/TR/html4/frameset.dtd");
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	81	return frameset;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	82	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	83
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	84	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	85	* This method is not supported by the class.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	86	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	87	* @param content content that needs to be added
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	88	* @throws DocletAbortException this method will always throw a
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	89	* DocletAbortException because it
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	90	* is not supported.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	91	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	92	public void addContent(Content content) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	93	throw new DocletAbortException();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	94	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	95
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	96	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	97	* This method is not supported by the class.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	98	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	99	* @param stringContent string content that needs to be added
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	100	* @throws DocletAbortException this method will always throw a
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	101	* DocletAbortException because it
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	102	* is not supported.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	103	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	104	public void addContent(String stringContent) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	105	throw new DocletAbortException();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	106	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	107
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	108	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	109	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	110	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	111	public boolean isEmpty() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	112	return (docType.length() == 0);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	113	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	114
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	115	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	116	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	117	*/
14265 4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	118	@Override
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	119	public boolean write(Writer out, boolean atNewline) throws IOException {
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	120	out.write(docType);
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	121	return true; // guaranteed by constructor
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	122	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	123	}

author	jjg
	Mon, 15 Oct 2012 17:07:55 -0700
changeset 14265	4e8e488eeae0
parent 14260	727a84636f12
child 14542	7062120649c2
permissions	-rw-r--r--