## org.apache.xml.serialize
Class SerializerFactory

    java.lang.Object
      org.apache.xml.serialize.SerializerFactory

    public abstract class SerializerFactory

extends java.lang.Object

Version:
  $Revision: 319808 $ $Date: 2004-02-24 18:34:05 -0500 (Tue, 24 Feb 2004) $
Author:
  Scott Boag, Assaf Arkin

Field Summary
`static java.lang.String` `FactoriesProperty`

Constructor Summary
`SerializerFactory()`

Method Summary
`static SerializerFactory` `getSerializerFactory(java.lang.String method)` Register a serializer factory, keyed by the given method string.
`protected abstract java.lang.String` `getSupportedMethod()` Returns the method supported by this factory and used to register the factory.
`abstract Serializer` `makeSerializer(OutputFormat format)` Create a new serializer based on the `OutputFormat`.
`abstract Serializer` `makeSerializer(java.io.OutputStream output, OutputFormat format)` Create a new serializer, based on the `OutputFormat` and using the output byte stream and the encoding specified in the output format.
`abstract Serializer` `makeSerializer(java.io.Writer writer, OutputFormat format)` Create a new serializer, based on the `OutputFormat` and using the writer as the output character stream.
`static void` `registerSerializerFactory(SerializerFactory factory)` Register a serializer factory, keyed by the given method string.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### FactoriesProperty

    public static final java.lang.String FactoriesProperty

See Also:
  Constant Field Values

Constructor Detail

### SerializerFactory

    public SerializerFactory()

Method Detail

### registerSerializerFactory

    public static void registerSerializerFactory(SerializerFactory factory)

  Register a serializer factory, keyed by the given method string.

### getSerializerFactory

    public static SerializerFactory getSerializerFactory(java.lang.String method)

  Register a serializer factory, keyed by the given method string.

### getSupportedMethod

    protected abstract java.lang.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 `OutputFormat`. If this method is used to create the serializer, the `Serializer.setOutputByteStream(java.io.OutputStream)` or `Serializer.setOutputCharStream(java.io.Writer)` methods must be called before serializing a document.

### makeSerializer

    public abstract Serializer makeSerializer(java.io.Writer writer,
                                              OutputFormat format)

  Create a new serializer, based on the `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(java.io.OutputStream output,
                                              OutputFormat format)
                                       throws java.io.UnsupportedEncodingException

  Create a new serializer, based on the `OutputFormat` and using the output byte stream and the encoding specified in the output format.

  Throws:
    `java.io.UnsupportedEncodingException` - The specified encoding is not supported

Copyright © 1999-2006 Apache XML Project. All Rights Reserved.