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