LibreOffice Module xmerge (master) 1
Public Member Functions | List of all members
org.openoffice.xmerge.DocumentSerializer2 Interface Reference

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

Inheritance diagram for org.openoffice.xmerge.DocumentSerializer2:
[legend]
Collaboration diagram for org.openoffice.xmerge.DocumentSerializer2:
[legend]

Public Member Functions

ConvertData serialize (String officeURL, String deviceURL) throws ConvertException, IOException
 Convert the data passed into the DocumentSerializer2 constructor into the "Device" Document format. More...
 
- Public Member Functions inherited from org.openoffice.xmerge.DocumentSerializer
ConvertData serialize () throws ConvertException, IOException
 Convert the data passed into the DocumentSerializer constructor into the "Device" Document format. More...
 

Detailed Description

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

The PluginFactory createDocumentSerializer method creates a DocumentSerializer, which may or may not implement DocumentSerializer2. When it is constructed, a "Office" Document object is passed in to be used as input.

See also
org.openoffice.xmerge.PluginFactory
org.openoffice.xmerge.DocumentSerializerFactory

Definition at line 38 of file DocumentSerializer2.java.

Member Function Documentation

◆ serialize()

ConvertData org.openoffice.xmerge.DocumentSerializer2.serialize ( String  officeURL,
String  deviceURL 
) throws ConvertException, IOException

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

The URL's passed may be used to resolve links and to name the output device document(s).

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.
Parameters
officeURLURL of the office document (may be null if unknown)
deviceURLURL of the device document (may be null if unknown)
Exceptions
ConvertExceptionIf any conversion error occurs.
IOExceptionIf any I/O error occurs.

The documentation for this interface was generated from the following file: