org.enhydra.apache.xml.serialize.Serializer Maven / Gradle / Ivy
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.apache.org. For more
* information on the Apache Software Foundation, please see
*
* To serialize a document using SAX events, create a compatible serializer
* using {@link #makeSAXSerializer} and pass it around as a {@link
* DocumentHandler}. If an I/O error occurs while serializing, it will
* be thrown by {@link DocumentHandler#endDocument}. The SAX serializer
* may also be used as {@link org.xml.sax.DTDHandler}, {@link DeclHandler} and
* {@link LexicalHandler}.
*
* To serialize a DOM document or DOM element, create a compatible
* serializer using {@link #makeSerializer} and call it's {@link
* #serialize(Document)} or {@link #serialize(Element)} methods.
* Both methods would produce a full XML document, to serizlie only
* the portion of the document use {@link OutputFormat#setOmitXMLDeclaration}
* and specify no document type.
*
* The convenience method {@link #serialize(Document,Writer,OutputFormat)}
* creates a serializer and calls {@link #serizlie(Document)} on that
* serialized.
*
* The {@link OutputFormat} dictates what underlying serialized is used
* to serialize the document based on the specified method. If the output
* format or method are missing, the default is an XML serializer with
* UTF-8 encoding and now indentation.
*
*
* @version $Revision: 1.2 $ $Date: 2005/01/26 08:28:45 $
* @author Assaf Arkin
* @author Scott Boag
* @see DocumentHandler
* @see ContentHandler
* @see OutputFormat
* @see DOMSerializer
*/
public interface Serializer
{
/**
* Specifies an output stream to which the document should be
* serialized. This method should not be called while the
* serializer is in the process of serializing a document.
*/
public void setOutputByteStream(OutputStream output);
/**
* Specifies a writer to which the document should be serialized.
* This method should not be called while the serializer is in
* the process of serializing a document.
*/
public void setOutputCharStream( Writer output );
/**
* Specifies an output format for this serializer. It the
* serializer has already been associated with an output format,
* it will switch to the new format. This method should not be
* called while the serializer is in the process of serializing
* a document.
*
* @param format The output format to use
*/
public void setOutputFormat( OutputFormat format );
/**
* Return a {@link DocumentHandler} interface into this serializer.
* If the serializer does not support the {@link DocumentHandler}
* interface, it should return null.
*/
public DocumentHandler asDocumentHandler()
throws IOException;
/**
* Return a {@link ContentHandler} interface into this serializer.
* If the serializer does not support the {@link ContentHandler}
* interface, it should return null.
*/
public ContentHandler asContentHandler()
throws IOException;
/**
* Return a {@link DOMSerializer} interface into this serializer.
* If the serializer does not support the {@link DOMSerializer}
* interface, it should return null.
*/
public DOMSerializer asDOMSerializer()
throws IOException;
}