KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hsqldb > persist > PersistentStore


1 /* Copyright (c) 2001-2005, The HSQL Development Group
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of the HSQL Development Group nor the names of its
15  * contributors may be used to endorse or promote products derived from this
16  * software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
22  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31
32 package org.hsqldb.persist;
33
34 import java.io.IOException JavaDoc;
35
36 import org.hsqldb.rowio.RowInputInterface;
37
38 /**
39  * Interface for a store for CachedObject object.
40  *
41  * @author fredt@users
42  * @version 1.8.0
43  * @since 1.8.0
44  */
45 public interface PersistentStore {
46
47     int INT_STORE_SIZE = 4;
48     int LONG_STORE_SIZE = 8;
49
50     /** get object */
51     CachedObject get(int key);
52
53     /** get object, ensuring future gets will return the same instance of the object */
54     CachedObject getKeep(int key);
55
56     int getStorageSize(int key);
57
58     /** add new object */
59     void add(CachedObject object) throws IOException JavaDoc;
60
61     /** add object previously removed from persistnce */
62     void restore(CachedObject object) throws IOException JavaDoc;
63
64     CachedObject get(RowInputInterface in) throws IOException JavaDoc;
65
66     CachedObject getNewInstance(int size) throws IOException JavaDoc;
67
68     /** remove the persisted image but not the cached copy */
69     void removePersistence(int i);
70
71     /** remove both persisted and cached copies */
72     void remove(int i);
73
74     /** remove the cached copies */
75     void release(int i);
76
77     /** commit persisted image */
78     void commit(CachedObject object);
79 }
80
Popular Tags