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: IBuffer.java 353 2005-12-21 14:29:33Z mat007 $
29 */
30
31 package palmed.buffer;
32
33 import palmed.file.IFile;
34 import palmed.io.ISerializable;
35
36 /***
37 * This interface defines the operations available on a buffer.
38 *
39 * @author Mathieu Champlon
40 * @version $Revision: 353 $ $Date: 2005-12-21 23:29:33 +0900 (mer., 21 déc. 2005) $
41 */
42 public interface IBuffer extends ISerializable
43 {
44 /***
45 * Open the given file.
46 *
47 * @param file the file to read from
48 */
49 void open( IFile file );
50
51 /***
52 * Save the file.
53 * <p>
54 * This operation must fail if no file is associated to the buffer.
55 *
56 * @return whether the file could be saved or not
57 */
58 boolean save();
59
60 /***
61 * Save into the given file.
62 *
63 * @param file the file to write into
64 */
65 void save( IFile file );
66
67 /***
68 * Test if the buffer has been modified.
69 *
70 * @return whether the buffer has been modified or not
71 */
72 boolean hasBeenModified();
73
74 /***
75 * Test if the given file is handled by the buffer.
76 *
77 * @param file the file
78 * @return whether the buffer handles the file or not
79 */
80 boolean hasFile( IFile file );
81
82 /***
83 * Delete the buffer.
84 */
85 void delete();
86 }