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 Dec 01 11:02:38 2010 -0800
1.3 @@ -0,0 +1,103 @@
1.4 +/*
1.5 + * Copyright (c) 2010, 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.util.*;
1.32 +import com.sun.tools.doclets.internal.toolkit.Content;
1.33 +import com.sun.tools.doclets.internal.toolkit.util.*;
1.34 +
1.35 +/**
1.36 + * Class for generating an HTML document for javadoc output.
1.37 + *
1.38 + * @author Bhavesh Patel
1.39 + */
1.40 +public class HtmlDocument extends Content {
1.41 +
1.42 + private List<Content> docContent = Collections.<Content>emptyList();
1.43 +
1.44 + /**
1.45 + * Constructor to construct an HTML document.
1.46 + *
1.47 + * @param docType document type for the HTML document
1.48 + * @param docComment comment for the document
1.49 + * @param htmlTree HTML tree of the document
1.50 + */
1.51 + public HtmlDocument(Content docType, Content docComment, Content htmlTree) {
1.52 + docContent = new ArrayList<Content>();
1.53 + addContent(nullCheck(docType));
1.54 + addContent(nullCheck(docComment));
1.55 + addContent(nullCheck(htmlTree));
1.56 + }
1.57 +
1.58 + /**
1.59 + * Constructor to construct an HTML document.
1.60 + *
1.61 + * @param docType document type for the HTML document
1.62 + * @param htmlTree HTML tree of the document
1.63 + */
1.64 + public HtmlDocument(Content docType, Content htmlTree) {
1.65 + docContent = new ArrayList<Content>();
1.66 + addContent(nullCheck(docType));
1.67 + addContent(nullCheck(htmlTree));
1.68 + }
1.69 +
1.70 + /**
1.71 + * Adds content for the HTML document.
1.72 + *
1.73 + * @param htmlContent html content to be added
1.74 + */
1.75 + public void addContent(Content htmlContent) {
1.76 + if (htmlContent.isValid())
1.77 + docContent.add(htmlContent);
1.78 + }
1.79 +
1.80 + /**
1.81 + * This method is not supported by the class.
1.82 + *
1.83 + * @param stringContent string content that needs to be added
1.84 + * @throws DocletAbortException this method will always throw a
1.85 + * DocletAbortException because it
1.86 + * is not supported.
1.87 + */
1.88 + public void addContent(String stringContent) {
1.89 + throw new DocletAbortException();
1.90 + }
1.91 +
1.92 + /**
1.93 + * {@inheritDoc}
1.94 + */
1.95 + public boolean isEmpty() {
1.96 + return (docContent.isEmpty());
1.97 + }
1.98 +
1.99 + /**
1.100 + * {@inheritDoc}
1.101 + */
1.102 + public void write(StringBuilder contentBuilder) {
1.103 + for (Content c : docContent)
1.104 + c.write(contentBuilder);
1.105 + }
1.106 +}
