KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > mckoi > store > Area


1 /**
2  * com.mckoi.store.Area 02 Sep 2002
3  *
4  * Mckoi SQL Database ( http://www.mckoi.com/database )
5  * Copyright (C) 2000, 2001, 2002 Diehl and Associates, Inc.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * 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  */
24
25 package com.mckoi.store;
26
27 import java.io.IOException JavaDoc;
28
29 /**
30  * An interface for access the contents of an area of a store. The area object
31  * maintains a pointer that can be manipulated and read from.
32  *
33  * @author Tobias Downer
34  */
35
36 public interface Area {
37
38   /**
39    * Returns the unique identifier that represents this area.
40    */
41   long getID();
42   
43   /**
44    * Returns the current position of the pointer within the area. The position
45    * starts at beginning of the area.
46    */
47   int position();
48   
49   /**
50    * Returns the capacity of the area.
51    */
52   int capacity();
53   
54   /**
55    * Sets the position within the area.
56    */
57   void position(int position) throws IOException JavaDoc;
58   
59   /**
60    * Copies 'size' bytes from the current position of this Area to the
61    * destination AreaWriter.
62    */
63   void copyTo(AreaWriter destination_writer, int size) throws IOException JavaDoc;
64   
65   // ---------- The get methods ----------
66 // Note that these methods will all increment the position by the size of the
67 // element read. For example, 'getInt' will increment the position by 4.
68
69   byte get() throws IOException JavaDoc;
70
71   void get(byte[] buf, int off, int len) throws IOException JavaDoc;
72   
73   short getShort() throws IOException JavaDoc;
74   
75   int getInt() throws IOException JavaDoc;
76   
77   long getLong() throws IOException JavaDoc;
78   
79   char getChar() throws IOException JavaDoc;
80
81 }
82
83
Popular Tags