blob: c1a5d7ba64d898db6f9991c281da1ae3d00eb688 (
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
* 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.OutputStream;
import java.io.InputStream;
import java.io.IOException;
/**
* <p>A <code>Document</code> represents any <code>Document</code>
* to be converted and the resulting <code>Document</code> from any
* conversion.</p>
*
* <p>It is created by the <code>PluginFactory</code> object's {@link
* org.openoffice.xmerge.PluginFactory#createOfficeDocument
* createOfficeDocument} method or the {@link
* org.openoffice.xmerge.PluginFactory#createDeviceDocument
* createDeviceDocument} method.</p>
*
* @see org.openoffice.xmerge.PluginFactory
*/
public interface Document {
/**
* <p>Writes out the <code>Document</code> content to the specified
* <code>OutputStream</code>.</p>
*
* <p>This method may not be thread-safe.
* Implementations may or may not synchronize this
* method. User code (i.e. caller) must make sure that
* calls to this method are thread-safe.</p>
*
* @param os <code>OutputStream</code> to write out the
* <code>Document</code> content.
*
* @throws IOException If any I/O error occurs.
*/
void write(OutputStream os) throws IOException;
/**
* <p>Reads the content from the <code>InputStream</code> into
* the <code>Document</code>.</p>
*
* <p>This method may not be thread-safe.
* Implementations may or may not synchronize this
* method. User code (i.e. caller) must make sure that
* calls to this method are thread-safe.</p>
*
* @param is <code>InputStream</code> to read in the
* <code>Document</code> content.
*
* @throws IOException If any I/O error occurs.
*/
void read(InputStream is) throws IOException;
/**
* Returns the <code>Document</code> name with no file extension.
*
* @return The <code>Document</code> name with no file extension.
*/
String getName();
/**
* Returns the <code>Document</code> name with file extension.
*
* @return The <code>Document</code> name with file extension.
*/
String getFileName();
}
|
