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

A DocumentDeserializer represents a converter that converts "Device" Document objects into the "Office" Document format. More...

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

Public Member Functions

Document deserialize (String deviceURL, String officeURL) throws ConvertException, IOException
 Convert the data passed into the DocumentDeserializer2 constructor into the "Office" 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 DocumentDeserializer represents a converter that converts "Device" Document objects into the "Office" Document format.

The PluginFactory createDocumentDeserializer method creates a DocumentDeserializer, which may or may not implement DocumentDeserializer2. When it is constructed, a ConvertData object is passed in to be used as input.

See also
org.openoffice.xmerge.PluginFactory
org.openoffice.xmerge.DocumentDeserializerFactory

Definition at line 38 of file DocumentDeserializer2.java.

Member Function Documentation

◆ deserialize()

Document org.openoffice.xmerge.DocumentDeserializer2.deserialize ( String  deviceURL,
String  officeURL 
) throws ConvertException, IOException

Convert the data passed into the DocumentDeserializer2 constructor into the "Office" Document format.

The URL's passed may be used to resolve links and to choose the name of the output office document.

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

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