HtmlDocument.java revision 3828:d30434bde0a8 
1/*
2 * Copyright (c) 2010, 2016, 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
26package jdk.javadoc.internal.doclets.formats.html.markup;
27
28import java.io.IOException;
29import java.io.Writer;
30import java.util.*;
31
32import jdk.javadoc.internal.doclets.toolkit.Content;
33
34/**
35 * Class for generating an HTML document for 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 */
44public class HtmlDocument extends Content {
45
46    private List<Content> docContent = Collections.emptyList();
47
48    /**
49     * Constructor to construct an HTML document.
50     *
51     * @param docType document type for the HTML document
52     * @param docComment comment for the document
53     * @param htmlTree HTML tree of the document
54     */
55    public HtmlDocument(Content docType, Content docComment, Content htmlTree) {
56        docContent = new ArrayList<>();
57        addContent(nullCheck(docType));
58        addContent(nullCheck(docComment));
59        addContent(nullCheck(htmlTree));
60    }
61
62    /**
63     * Constructor to construct an HTML document.
64     *
65     * @param docType document type for the HTML document
66     * @param htmlTree HTML tree of the document
67     */
68    public HtmlDocument(Content docType, Content htmlTree) {
69        docContent = new ArrayList<>();
70        addContent(nullCheck(docType));
71        addContent(nullCheck(htmlTree));
72    }
73
74    /**
75     * Adds content for the HTML document.
76     *
77     * @param htmlContent html content to be added
78     */
79    public final void addContent(Content htmlContent) {
80        if (htmlContent.isValid())
81            docContent.add(htmlContent);
82    }
83
84    /**
85     * This method is not supported by the class.
86     *
87     * @param stringContent string content that needs to be added
88     * @throws UnsupportedOperationException always
89     */
90    @Override
91    public void addContent(CharSequence stringContent) {
92        throw new UnsupportedOperationException();
93    }
94
95    /**
96     * {@inheritDoc}
97     */
98    public boolean isEmpty() {
99        return (docContent.isEmpty());
100    }
101
102    /**
103     * {@inheritDoc}
104     */
105    public boolean write(Writer out,  boolean atNewline) throws IOException {
106        for (Content c : docContent)
107            atNewline = c.write(out, atNewline);
108        return atNewline;
109    }
110}
111