blob: c31e07c54ef10b54372fb7bb54e686d96808a36f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package org.openoffice.xmerge;
import java.io.IOException;
/**
* A {@code DocumentSerializer} represents a converter that converts a
* "Office" {@code Document} to a "Device" {@code Document}
* format.
*
* <p>The {@code DocumentSerializer} object is created by a the
* {@code PluginFactory} {@link
* org.openoffice.xmerge.DocumentSerializerFactory#createDocumentSerializer
* createDocumentSerializer} method. When it is constructed, a
* "Office" {@code Document} object is passed in to be used as input.
* </p>
*
* @see org.openoffice.xmerge.PluginFactory
* @see org.openoffice.xmerge.DocumentSerializerFactory
*/
public interface DocumentSerializer {
/**
* Convert the data passed into the {@code DocumentSerializer} constructor
* into the "Device" {@code Document} format.
*
* <p>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.</p>
*
* @return {@code ConvertData} object to pass back the converted data.
*
* @throws ConvertException If any conversion error occurs.
* @throws IOException If any I/O error occurs.
*/
ConvertData serialize() throws ConvertException, IOException;
}
|
