/*

 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.doclets.formats.html.markup;

import java.io.IOException;

import java.io.Writer;

import java.util.*;

import com.sun.tools.doclets.internal.toolkit.Content;

import com.sun.tools.doclets.internal.toolkit.util.*;

/**

 * Class for generating an HTML document for javadoc output.

 *

 *  <p><b>This is NOT part of any supported API.

 *  If you write code that depends on this, you do so at your own risk.

 *  This code and its internal interfaces are subject to change or

 *  deletion without notice.</b>

 *

 * @author Bhavesh Patel

 */

public class HtmlDocument extends Content {

    private List<Content> docContent = Collections.<Content>emptyList();

    /**

     * Constructor to construct an HTML document.

     *

     * @param docType document type for the HTML document

     * @param docComment comment for the document

     * @param htmlTree HTML tree of the document

     */

    public HtmlDocument(Content docType, Content docComment, Content htmlTree) {

        addContent(nullCheck(docType));

        addContent(nullCheck(docComment));

        addContent(nullCheck(htmlTree));

    }

    /**

     * Constructor to construct an HTML document.

     *

     * @param docType document type for the HTML document

     * @param htmlTree HTML tree of the document

     */

    public HtmlDocument(Content docType, Content htmlTree) {

        addContent(nullCheck(docType));

        addContent(nullCheck(htmlTree));

    }

    /**

     * Adds content for the HTML document.

     *

     * @param htmlContent html content to be added

     */

    public final void addContent(Content htmlContent) {

        if (htmlContent.isValid())

            docContent.add(htmlContent);

    }

    /**

     * This method is not supported by the class.

     *

     * @param stringContent string content that needs to be added

     * @throws DocletAbortException this method will always throw a

     *                              DocletAbortException because it

     *                              is not supported.

     */

    public void addContent(String stringContent) {

        throw new DocletAbortException("not supported");

    }

    /**

     * {@inheritDoc}

     */

    public boolean isEmpty() {

        return (docContent.isEmpty());

    }

    /**

     * {@inheritDoc}

     */

    public boolean write(Writer out,  boolean atNewline) throws IOException {

        for (Content c : docContent)

            atNewline = c.write(out, atNewline);

        return atNewline;

    }

}