KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xml > internal > serialize > Serializer


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58
59 package com.sun.org.apache.xml.internal.serialize;
60
61
62 import java.io.IOException JavaDoc;
63 import java.io.OutputStream JavaDoc;
64 import java.io.Writer JavaDoc;
65
66 import org.xml.sax.ContentHandler JavaDoc;
67 import org.xml.sax.DocumentHandler JavaDoc;
68
69
70 /**
71  * Interface for a DOM serializer implementation, factory for DOM and SAX
72  * serializers, and static methods for serializing DOM documents.
73  * <p>
74  * To serialize a document using SAX events, create a compatible serializer
75  * and pass it around as a {@link
76  * org.xml.sax.DocumentHandler}. If an I/O error occurs while serializing, it will
77  * be thrown by {@link DocumentHandler#endDocument}. The SAX serializer
78  * may also be used as {@link org.xml.sax.DTDHandler}, {@link org.xml.sax.ext.DeclHandler} and
79  * {@link org.xml.sax.ext.LexicalHandler}.
80  * <p>
81  * To serialize a DOM document or DOM element, create a compatible
82  * serializer and call it's {@link
83  * DOMSerializer#serialize(Document)} or {@link DOMSerializer#serialize(Element)} methods.
84  * Both methods would produce a full XML document, to serizlie only
85  * the portion of the document use {@link OutputFormat#setOmitXMLDeclaration}
86  * and specify no document type.
87  * <p>
88  * The {@link OutputFormat} dictates what underlying serialized is used
89  * to serialize the document based on the specified method. If the output
90  * format or method are missing, the default is an XML serializer with
91  * UTF-8 encoding and now indentation.
92  *
93  *
94  * @version $Revision: 1.13 $ $Date: 2003/05/13 13:23:49 $
95  * @author <a HREF="mailto:arkin@intalio.com">Assaf Arkin</a>
96  * @author <a HREF="mailto:Scott_Boag/CAM/Lotus@lotus.com">Scott Boag</a>
97  * @see DocumentHandler
98  * @see ContentHandler
99  * @see OutputFormat
100  * @see DOMSerializer
101  */
102 public interface Serializer
103 {
104
105
106     /**
107      * Specifies an output stream to which the document should be
108      * serialized. This method should not be called while the
109      * serializer is in the process of serializing a document.
110      */
111     public void setOutputByteStream(OutputStream JavaDoc output);
112     
113
114     /**
115      * Specifies a writer to which the document should be serialized.
116      * This method should not be called while the serializer is in
117      * the process of serializing a document.
118      */
119     public void setOutputCharStream( Writer JavaDoc output );
120
121
122     /**
123      * Specifies an output format for this serializer. It the
124      * serializer has already been associated with an output format,
125      * it will switch to the new format. This method should not be
126      * called while the serializer is in the process of serializing
127      * a document.
128      *
129      * @param format The output format to use
130      */
131     public void setOutputFormat( OutputFormat format );
132
133
134     /**
135      * Return a {@link DocumentHandler} interface into this serializer.
136      * If the serializer does not support the {@link DocumentHandler}
137      * interface, it should return null.
138      */
139     public DocumentHandler JavaDoc asDocumentHandler()
140         throws IOException JavaDoc;
141
142
143     /**
144      * Return a {@link ContentHandler} interface into this serializer.
145      * If the serializer does not support the {@link ContentHandler}
146      * interface, it should return null.
147      */
148     public ContentHandler JavaDoc asContentHandler()
149         throws IOException JavaDoc;
150
151
152     /**
153      * Return a {@link DOMSerializer} interface into this serializer.
154      * If the serializer does not support the {@link DOMSerializer}
155      * interface, it should return null.
156      */
157     public DOMSerializer asDOMSerializer()
158         throws IOException JavaDoc;
159
160
161 }
162
163
164
165
166
167
Popular Tags