KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > perseus > fos > api > FosStructure


1 /**
2  * Copyright (C) 2000
3  */
4
5 package org.objectweb.perseus.fos.api;
6
7 import java.io.ObjectInputStream JavaDoc;
8 import java.io.ObjectOutputStream JavaDoc;
9
10 /**
11  * Defines the object for reading/writing the content of a persistent object
12  * from/to its associated file within the File Object Store. This interface is
13  * implemented by the FOS user that must provide it in order to define the exact
14  * storage structure of stored objects.
15  * @author S. Chassande-Barrioz, P. Déchamboux
16  */
17 public interface FosStructure {
18     /**
19      * Reads the content of a persistent object from the file represented by
20      * the given ObjectInputStream.
21      * @param ois The ObjectInputStream representing the file from which to
22      * read.
23      * @param conn The connection used to access the File Object Store.
24      */
25     void readFile(ObjectInputStream JavaDoc ois, FosAccess conn, Object JavaDoc ctxt) throws Exception JavaDoc;
26
27     /**
28      * Writes the content of a persistent object to the file represented by
29      * the given ObjectOutputStream.
30      * @param oos The ObjectOutputStream representing the file to which to
31      * write.
32      * @param conn The connection used to access the File Object Store.
33      */
34     void writeFile(ObjectOutputStream JavaDoc oos, FosAccess conn, Object JavaDoc ctxt) throws Exception JavaDoc;
35 }
36
Popular Tags