KickJava   Java API By Example, From Geeks To Geeks.

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


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.OutputStream JavaDoc;
63 import java.io.Writer JavaDoc;
64 import java.io.UnsupportedEncodingException JavaDoc;
65 import java.util.Hashtable JavaDoc;
66 import java.util.StringTokenizer JavaDoc;
67
68 /**
69  *
70  *
71  * @version $Revision: 1.9 $ $Date: 2004/02/17 07:14:49 $
72  * @author <a HREF="mailto:Scott_Boag/CAM/Lotus@lotus.com">Scott Boag</a>
73  * @author <a HREF="mailto:arkin@intalio.com">Assaf Arkin</a>
74  */
75 public abstract class SerializerFactory
76 {
77
78
79     public static final String JavaDoc FactoriesProperty = "com.sun.org.apache.xml.internal.serialize.factories";
80
81
82     private static Hashtable JavaDoc _factories = new Hashtable JavaDoc();
83
84
85     static
86     {
87         SerializerFactory factory;
88         String JavaDoc list;
89         StringTokenizer JavaDoc token;
90         String JavaDoc className;
91
92         // The default factories are always registered first,
93 // any factory specified in the properties file and supporting
94 // the same method will override the default factory.
95 factory = new SerializerFactoryImpl( Method.XML );
96         registerSerializerFactory( factory );
97         factory = new SerializerFactoryImpl( Method.HTML );
98         registerSerializerFactory( factory );
99         factory = new SerializerFactoryImpl( Method.XHTML );
100         registerSerializerFactory( factory );
101         factory = new SerializerFactoryImpl( Method.TEXT );
102         registerSerializerFactory( factory );
103
104         list = System.getProperty( FactoriesProperty );
105         if ( list != null ) {
106             token = new StringTokenizer JavaDoc( list, " ;,:" );
107             while ( token.hasMoreTokens() ) {
108                 className = token.nextToken();
109                 try {
110                     factory = (SerializerFactory) ObjectFactory.newInstance( className,
111                         SerializerFactory.class.getClassLoader(), true);
112                     if ( _factories.containsKey( factory.getSupportedMethod() ) )
113                         _factories.put( factory.getSupportedMethod(), factory );
114                 } catch ( Exception JavaDoc except ) { }
115             }
116         }
117     }
118
119
120     /**
121      * Register a serializer factory, keyed by the given
122      * method string.
123      */
124     public static void registerSerializerFactory( SerializerFactory factory )
125     {
126         String JavaDoc method;
127
128         synchronized ( _factories ) {
129             method = factory.getSupportedMethod();
130             _factories.put( method, factory );
131         }
132     }
133
134
135     /**
136      * Register a serializer factory, keyed by the given
137      * method string.
138      */
139     public static SerializerFactory getSerializerFactory( String JavaDoc method )
140     {
141         return (SerializerFactory) _factories.get( method );
142     }
143
144
145     /**
146      * Returns the method supported by this factory and used to register
147      * the factory. This call is required so factories can be added from
148      * a properties file by knowing only the class name. This method is
149      * protected, it is only required by this class but must be implemented
150      * in derived classes.
151      */
152     protected abstract String JavaDoc getSupportedMethod();
153
154
155     /**
156      * Create a new serializer based on the {@link OutputFormat}.
157      * If this method is used to create the serializer, the {@link
158      * Serializer#setOutputByteStream} or {@link Serializer#setOutputCharStream}
159      * methods must be called before serializing a document.
160      */
161     public abstract Serializer makeSerializer(OutputFormat format);
162
163
164     /**
165      * Create a new serializer, based on the {@link OutputFormat} and
166      * using the writer as the output character stream. If this
167      * method is used, the encoding property will be ignored.
168      */
169     public abstract Serializer makeSerializer( Writer JavaDoc writer,
170                                                OutputFormat format );
171
172
173     /**
174      * Create a new serializer, based on the {@link OutputFormat} and
175      * using the output byte stream and the encoding specified in the
176      * output format.
177      *
178      * @throws UnsupportedEncodingException The specified encoding is
179      * not supported
180      */
181     public abstract Serializer makeSerializer( OutputStream JavaDoc output,
182                                                OutputFormat format )
183         throws UnsupportedEncodingException JavaDoc;
184
185
186 }
187
188
189
Popular Tags