1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: IFile.java 264 2005-09-26 20:51:16Z mat007 $
29 */
30
31 package palmed.file;
32
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.io.OutputStream;
36
37 /***
38 * This interface defines the operations available on a file.
39 *
40 * @author Mathieu Champlon
41 * @version $Revision: 264 $ $Date: 2005-09-27 05:51:16 +0900 (mar., 27 sept. 2005) $
42 */
43 public interface IFile
44 {
45 /***
46 * Open an input stream.
47 * <p>
48 * The stream must be closed after being used.
49 *
50 * @return the input stream
51 * @throws IOException an io exception occured
52 */
53 InputStream openInputStream() throws IOException;
54
55 /***
56 * Open an output stream.
57 * <p>
58 * The stream must be closed after being used.
59 *
60 * @return the output stream
61 * @throws IOException an io exception occured
62 */
63 OutputStream openOutputStream() throws IOException;
64
65 /***
66 * Test if the file exists.
67 *
68 * @return whether the file exists or not
69 */
70 boolean exists();
71 }