OpenOffice.org
XMerge API

org.openoffice.xmerge
Interface DocumentSerializer

All Known Implementing Classes:
SxcDocumentSerializer, DocumentSerializerImpl, DocumentSerializerImpl, DocumentSerializerImpl

public interface DocumentSerializer

A DocumentSerializer represents a converter that converts a "Office" Document to a "Device" Document format.

The DocumentSerializer object is created by a the PluginFactory createDocumentSerializer method. When it is constructed, a "Office" Document object is passed in to be used as input.

See Also:
PluginFactory, DocumentSerializerFactory

Method Summary
 ConvertData serialize()
          Convert the data passed into the DocumentSerializer constructor into the "Device" Document format.
 

Method Detail

serialize

public ConvertData serialize()
                      throws ConvertException,
                             java.io.IOException

Convert the data passed into the DocumentSerializer constructor into the "Device" Document format.

This method may or may not be thread-safe. It is expected that the user code does not call this method in more than one thread. And for most cases, this method is only done once.

Returns:
ConvertData object to pass back the converted data.
Throws:
ConvertException - If any conversion error occurs.
java.io.IOException - If any I/O error occurs.

OpenOffice.org
XMerge API

Copyright © 2002 OpenOffice.org