src/share/classes/com/sun/tools/doclets/formats/html/markup/DocType.java

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2010, 2013, 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 package com.sun.tools.doclets.formats.html.markup;
aoqi@0 27
aoqi@0 28 import java.io.IOException;
aoqi@0 29 import java.io.Writer;
aoqi@0 30
aoqi@0 31 import com.sun.tools.doclets.internal.toolkit.Content;
aoqi@0 32 import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0 33
aoqi@0 34 /**
aoqi@0 35 * Class for generating document type for HTML pages of javadoc output.
aoqi@0 36 *
aoqi@0 37 * <p><b>This is NOT part of any supported API.
aoqi@0 38 * If you write code that depends on this, you do so at your own risk.
aoqi@0 39 * This code and its internal interfaces are subject to change or
aoqi@0 40 * deletion without notice.</b>
aoqi@0 41 *
aoqi@0 42 * @author Bhavesh Patel
aoqi@0 43 */
aoqi@0 44 public class DocType extends Content {
aoqi@0 45
aoqi@0 46 private String docType;
aoqi@0 47
aoqi@0 48 public static final DocType TRANSITIONAL =
aoqi@0 49 new DocType("Transitional", "http://www.w3.org/TR/html4/loose.dtd");
aoqi@0 50
aoqi@0 51 public static final DocType FRAMESET =
aoqi@0 52 new DocType("Frameset", "http://www.w3.org/TR/html4/frameset.dtd");
aoqi@0 53
aoqi@0 54 /**
aoqi@0 55 * Constructor to construct a DocType object.
aoqi@0 56 *
aoqi@0 57 * @param type the doctype to be added
aoqi@0 58 */
aoqi@0 59 private DocType(String type, String dtd) {
aoqi@0 60 docType = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 " + type +
aoqi@0 61 "//EN\" \"" + dtd + "\">" + DocletConstants.NL;
aoqi@0 62 }
aoqi@0 63
aoqi@0 64 /**
aoqi@0 65 * This method is not supported by the class.
aoqi@0 66 *
aoqi@0 67 * @param content content that needs to be added
aoqi@0 68 * @throws DocletAbortException this method will always throw a
aoqi@0 69 * DocletAbortException because it
aoqi@0 70 * is not supported.
aoqi@0 71 */
aoqi@0 72 public void addContent(Content content) {
aoqi@0 73 throw new DocletAbortException("not supported");
aoqi@0 74 }
aoqi@0 75
aoqi@0 76 /**
aoqi@0 77 * This method is not supported by the class.
aoqi@0 78 *
aoqi@0 79 * @param stringContent string content that needs to be added
aoqi@0 80 * @throws DocletAbortException this method will always throw a
aoqi@0 81 * DocletAbortException because it
aoqi@0 82 * is not supported.
aoqi@0 83 */
aoqi@0 84 public void addContent(String stringContent) {
aoqi@0 85 throw new DocletAbortException("not supported");
aoqi@0 86 }
aoqi@0 87
aoqi@0 88 /**
aoqi@0 89 * {@inheritDoc}
aoqi@0 90 */
aoqi@0 91 public boolean isEmpty() {
aoqi@0 92 return (docType.length() == 0);
aoqi@0 93 }
aoqi@0 94
aoqi@0 95 /**
aoqi@0 96 * {@inheritDoc}
aoqi@0 97 */
aoqi@0 98 @Override
aoqi@0 99 public boolean write(Writer out, boolean atNewline) throws IOException {
aoqi@0 100 out.write(docType);
aoqi@0 101 return true; // guaranteed by constructor
aoqi@0 102 }
aoqi@0 103 }

mercurial