1 /*
2 * Copyright 2005 Werner Guttmann
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5 * in compliance with the License. You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software distributed under the License
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11 * or implied. See the License for the specific language governing permissions and limitations under
12 * the License.
13 */
14 package org.exolab.castor.xml;
15
16 /**
17 * Configurable factory object for XML serialization.
18 *
19 * The XML serializer factory is set through the <tt>org.exolab.castor.xml.serializer.factory</tt>
20 * in the <tt>castor.properties</tt> file shipped with the product JAR. By default, this is set to a
21 * value of <tt>org.exolab.castor.xml.XercesJDK5XMLSerializerFactory</tt>. This
22 * {@link XMLSerializerFactory} will use the Xerces instance as shipped with the JRE.
23 *
24 * To use another {@link XMLSerializerFactory}, please override this property in a custom
25 * <tt>castor.properties</tt>.
26 *
27 * When using Castor XML with JDK 5.0 and above, you may switch to the
28 * {@link XercesXMLSerializerFactory}, which will use a separately downloaded Xerces instance, and
29 * not the one shipped with the JRE itself.
30 *
31 * @author <a href="mailto:werner DOT guttmann AT gmx DOT net">Werner Guttmann</a>
32 * @version $Revision$ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
33 *
34 * @since 1.0
35 */
36 public interface XMLSerializerFactory {
37
38 /**
39 * Factory method for obtaining a Serializer instance.
40 *
41 * @return A Serializer instance.
42 */
43 Serializer getSerializer();
44
45 /**
46 * Factory method for obtaining a OutputFormat instance.
47 *
48 * @return A OutputFormat instance.
49 */
50 OutputFormat getOutputFormat();
51 }