jdk-sandbox: langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java@d31e4986dc8b (annotated)

7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	1	/*
36500 d31e4986dc8b 8149139: [javadoc] Modify Content to accept CharSequence ksrini parents: 35426 diff changeset	2	* Copyright (c) 2010, 2016, 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
35426 374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs ksrini parents: 29957 diff changeset	26	package jdk.javadoc.internal.doclets.formats.html.markup;
7614 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
35426 374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs ksrini parents: 29957 diff changeset	31	import jdk.javadoc.internal.doclets.toolkit.Content;
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs ksrini parents: 29957 diff changeset	32	import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs ksrini parents: 29957 diff changeset	33	import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
7614 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	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	36	* 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	37	*
14260 727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	38	* <p><b>This is NOT part of any supported API.
727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	39	* 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	40	* 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	41	* deletion without notice.</b>
727a84636f12 8000665: fix "internal API" comments on javadoc files jjg parents: 7641 diff changeset	42	*
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	43	* @author Bhavesh Patel
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	44	*/
14542 7062120649c2 8000800: javadoc uses static non-final fields jjg parents: 14265 diff changeset	45	public class DocType extends Content {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	46
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	47	private String docType;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	48
14542 7062120649c2 8000800: javadoc uses static non-final fields jjg parents: 14265 diff changeset	49	public static final DocType TRANSITIONAL =
7062120649c2 8000800: javadoc uses static non-final fields jjg parents: 14265 diff changeset	50	new DocType("Transitional", "http://www.w3.org/TR/html4/loose.dtd");
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	51
29957 7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	52	public static final DocType HTML5 = new DocType();
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	53
7614 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	* Constructor to construct a DocType object.
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	* @param type the doctype to be added
29957 7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	58	* @param dtd the dtd of the doctype
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	59	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	60	private DocType(String type, String dtd) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	61	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	62	"//EN\" \"" + dtd + "\">" + DocletConstants.NL;
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	63	}
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	/**
29957 7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	66	* Constructor to construct a DocType object.
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	67	*/
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	68	private DocType() {
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	69	docType = "<!DOCTYPE HTML>" + DocletConstants.NL;
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	70	}
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	71
7740f9657f56 8072945: Javadoc should generate valid and compliant HTML5 output bpatel parents: 29429 diff changeset	72	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	73	* 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	74	*
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	75	* @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	76	* @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	77	* DocletAbortException because it
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	78	* is not supported.
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	79	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	80	public void addContent(Content content) {
19667 fdfce85627a9 8001669: javadoc internal DocletAbortException should set cause when appropriate jjg parents: 14542 diff changeset	81	throw new DocletAbortException("not supported");
7614 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 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	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	*/
36500 d31e4986dc8b 8149139: [javadoc] Modify Content to accept CharSequence ksrini parents: 35426 diff changeset	92	@Override
d31e4986dc8b 8149139: [javadoc] Modify Content to accept CharSequence ksrini parents: 35426 diff changeset	93	public void addContent(CharSequence stringContent) {
19667 fdfce85627a9 8001669: javadoc internal DocletAbortException should set cause when appropriate jjg parents: 14542 diff changeset	94	throw new DocletAbortException("not supported");
7614 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	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	98	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	99	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	100	public boolean isEmpty() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	101	return (docType.length() == 0);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	102	}
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	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	105	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	106	*/
14265 4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	107	@Override
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	108	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	109	out.write(docType);
4e8e488eeae0 8000666: javadoc should write directly to Writer instead of composing strings jjg parents: 14260 diff changeset	110	return true; // guaranteed by constructor
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	111	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: diff changeset	112	}

author	ksrini
	Wed, 24 Feb 2016 15:31:36 -0800
changeset 36500	d31e4986dc8b
parent 35426	374342e56a56
child 40587	1c355ea550ed
permissions	-rw-r--r--