1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlDocument.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,112 @@
1.4 +/*
1.5 + * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.formats.html.markup;
1.30 +
1.31 +import java.io.IOException;
1.32 +import java.io.Writer;
1.33 +import java.util.*;
1.34 +
1.35 +import com.sun.tools.doclets.internal.toolkit.Content;
1.36 +import com.sun.tools.doclets.internal.toolkit.util.*;
1.37 +
1.38 +/**
1.39 + * Class for generating an HTML document for javadoc output.
1.40 + *
1.41 + * <p><b>This is NOT part of any supported API.
1.42 + * If you write code that depends on this, you do so at your own risk.
1.43 + * This code and its internal interfaces are subject to change or
1.44 + * deletion without notice.</b>
1.45 + *
1.46 + * @author Bhavesh Patel
1.47 + */
1.48 +public class HtmlDocument extends Content {
1.49 +
1.50 + private List<Content> docContent = Collections.<Content>emptyList();
1.51 +
1.52 + /**
1.53 + * Constructor to construct an HTML document.
1.54 + *
1.55 + * @param docType document type for the HTML document
1.56 + * @param docComment comment for the document
1.57 + * @param htmlTree HTML tree of the document
1.58 + */
1.59 + public HtmlDocument(Content docType, Content docComment, Content htmlTree) {
1.60 + docContent = new ArrayList<Content>();
1.61 + addContent(nullCheck(docType));
1.62 + addContent(nullCheck(docComment));
1.63 + addContent(nullCheck(htmlTree));
1.64 + }
1.65 +
1.66 + /**
1.67 + * Constructor to construct an HTML document.
1.68 + *
1.69 + * @param docType document type for the HTML document
1.70 + * @param htmlTree HTML tree of the document
1.71 + */
1.72 + public HtmlDocument(Content docType, Content htmlTree) {
1.73 + docContent = new ArrayList<Content>();
1.74 + addContent(nullCheck(docType));
1.75 + addContent(nullCheck(htmlTree));
1.76 + }
1.77 +
1.78 + /**
1.79 + * Adds content for the HTML document.
1.80 + *
1.81 + * @param htmlContent html content to be added
1.82 + */
1.83 + public final void addContent(Content htmlContent) {
1.84 + if (htmlContent.isValid())
1.85 + docContent.add(htmlContent);
1.86 + }
1.87 +
1.88 + /**
1.89 + * This method is not supported by the class.
1.90 + *
1.91 + * @param stringContent string content that needs to be added
1.92 + * @throws DocletAbortException this method will always throw a
1.93 + * DocletAbortException because it
1.94 + * is not supported.
1.95 + */
1.96 + public void addContent(String stringContent) {
1.97 + throw new DocletAbortException("not supported");
1.98 + }
1.99 +
1.100 + /**
1.101 + * {@inheritDoc}
1.102 + */
1.103 + public boolean isEmpty() {
1.104 + return (docContent.isEmpty());
1.105 + }
1.106 +
1.107 + /**
1.108 + * {@inheritDoc}
1.109 + */
1.110 + public boolean write(Writer out, boolean atNewline) throws IOException {
1.111 + for (Content c : docContent)
1.112 + atNewline = c.write(out, atNewline);
1.113 + return atNewline;
1.114 + }
1.115 +}
