/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/*

 * Copyright 1999-2002,2004 The Apache Software Foundation.

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.sun.org.apache.xml.internal.serialize;

import java.io.IOException;

import org.w3c.dom.Element;

import org.w3c.dom.Document;

import org.w3c.dom.DocumentFragment;

/**

 * Interface for a DOM serializer implementation.

 *

 *

 * @author <a href="mailto:Scott_Boag/CAM/Lotus@lotus.com">Scott Boag</a>

 * @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>

 */

public interface DOMSerializer

{

    /**

     * Serialized the DOM element. Throws an exception only if

     * an I/O exception occured while serializing.

     *

     * @param elem The element to serialize

     * @throws IOException An I/O exception occured while

     *   serializing

     */

    public void serialize( Element elem )

        throws IOException;

    /**

     * Serializes the DOM document. Throws an exception only if

     * an I/O exception occured while serializing.

     *

     * @param doc The document to serialize

     * @throws IOException An I/O exception occured while

     *   serializing

     */

    public void serialize( Document doc )

        throws IOException;

    /**

     * Serializes the DOM document fragment. Throws an exception

     * only if an I/O exception occured while serializing.

     *

     * @param frag The document fragment to serialize

     * @throws IOException An I/O exception occured while

     *   serializing

     */

    public void serialize( DocumentFragment frag )

        throws IOException;

}