org.apache.xml.serialize

Class SerializerFactory

public abstract class SerializerFactory extends Object

Version: $Revision: 1.10 $ $Date: 2004/02/24 23:34:03 $

Author: Scott Boag Assaf Arkin

Field Summary
static StringFactoriesProperty
Method Summary
static SerializerFactorygetSerializerFactory(String method)
Register a serializer factory, keyed by the given method string.
protected abstract StringgetSupportedMethod()
Returns the method supported by this factory and used to register the factory.
abstract SerializermakeSerializer(OutputFormat format)
Create a new serializer based on the {@link OutputFormat}.
abstract SerializermakeSerializer(Writer writer, OutputFormat format)
Create a new serializer, based on the {@link OutputFormat} and using the writer as the output character stream.
abstract SerializermakeSerializer(OutputStream output, OutputFormat format)
Create a new serializer, based on the {@link OutputFormat} and using the output byte stream and the encoding specified in the output format.
static voidregisterSerializerFactory(SerializerFactory factory)
Register a serializer factory, keyed by the given method string.

Field Detail

FactoriesProperty

public static final String FactoriesProperty

Method Detail

getSerializerFactory

public static SerializerFactory getSerializerFactory(String method)
Register a serializer factory, keyed by the given method string.

getSupportedMethod

protected abstract String getSupportedMethod()
Returns the method supported by this factory and used to register the factory. This call is required so factories can be added from a properties file by knowing only the class name. This method is protected, it is only required by this class but must be implemented in derived classes.

makeSerializer

public abstract Serializer makeSerializer(OutputFormat format)
Create a new serializer based on the {@link OutputFormat}. If this method is used to create the serializer, the {@link Serializer#setOutputByteStream} or {@link Serializer#setOutputCharStream} methods must be called before serializing a document.

makeSerializer

public abstract Serializer makeSerializer(Writer writer, OutputFormat format)
Create a new serializer, based on the {@link OutputFormat} and using the writer as the output character stream. If this method is used, the encoding property will be ignored.

makeSerializer

public abstract Serializer makeSerializer(OutputStream output, OutputFormat format)
Create a new serializer, based on the {@link OutputFormat} and using the output byte stream and the encoding specified in the output format.

Throws: UnsupportedEncodingException The specified encoding is not supported

registerSerializerFactory

public static void registerSerializerFactory(SerializerFactory factory)
Register a serializer factory, keyed by the given method string.
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.