01: /**
02: * com.mckoi.store.Area 02 Sep 2002
03: *
04: * Mckoi SQL Database ( http://www.mckoi.com/database )
05: * Copyright (C) 2000, 2001, 2002 Diehl and Associates, Inc.
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License
09: * Version 2 as published by the Free Software Foundation.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License Version 2 for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * Version 2 along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19: *
20: * Change Log:
21: *
22: *
23: */package com.mckoi.store;
24:
25: import java.io.IOException;
26:
27: /**
28: * An interface for access the contents of an area of a store. The area object
29: * maintains a pointer that can be manipulated and read from.
30: *
31: * @author Tobias Downer
32: */
33:
34: public interface Area {
35:
36: /**
37: * Returns the unique identifier that represents this area.
38: */
39: long getID();
40:
41: /**
42: * Returns the current position of the pointer within the area. The position
43: * starts at beginning of the area.
44: */
45: int position();
46:
47: /**
48: * Returns the capacity of the area.
49: */
50: int capacity();
51:
52: /**
53: * Sets the position within the area.
54: */
55: void position(int position) throws IOException;
56:
57: /**
58: * Copies 'size' bytes from the current position of this Area to the
59: * destination AreaWriter.
60: */
61: void copyTo(AreaWriter destination_writer, int size)
62: throws IOException;
63:
64: // ---------- The get methods ----------
65: // Note that these methods will all increment the position by the size of the
66: // element read. For example, 'getInt' will increment the position by 4.
67:
68: byte get() throws IOException;
69:
70: void get(byte[] buf, int off, int len) throws IOException;
71:
72: short getShort() throws IOException;
73:
74: int getInt() throws IOException;
75:
76: long getLong() throws IOException;
77:
78: char getChar() throws IOException;
79:
80: }
|