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: IBufferManager.java 360 2005-12-24 14:35:35Z 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 manager.
38 *
39 * @author Mathieu Champlon
40 * @version $Revision: 360 $ $Date: 2005-12-24 23:35:35 +0900 (sam., 24 déc. 2005) $
41 */
42 public interface IBufferManager extends ISerializable
43 {
44 /***
45 * Open an empty buffer.
46 */
47 void open();
48
49 /***
50 * Open the given file in a buffer.
51 *
52 * @param file the file to read from
53 */
54 void open( IFile file );
55
56 /***
57 * Close the current buffer.
58 */
59 void close();
60
61 /***
62 * Save the file in the current buffer.
63 * <p>
64 * This operation must fail if no file is associated to the buffer.
65 *
66 * @return whether the file could be saved or not
67 */
68 boolean save();
69
70 /***
71 * Save the current buffer into the given file.
72 *
73 * @param file the file to write into
74 */
75 void save( IFile file );
76
77 /***
78 * Test if the current buffer has been modified.
79 *
80 * @return whether the buffer has been modified or not
81 */
82 boolean hasBeenModified();
83
84 /***
85 * Switch to the previous buffer.
86 */
87 void previous();
88
89 /***
90 * Switch to the next buffer.
91 */
92 void next();
93 }