KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > joram > shared > stream > Streamable


1 /*
2  * JORAM: Java(TM) Open Reliable Asynchronous Messaging
3  * Copyright (C) 2006 ScalAgent Distributed Technologies
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18  * USA.
19  *
20  * Initial developer(s): ScalAgent Distributed Technologies
21  * Contributor(s):
22  */

23 package org.objectweb.joram.shared.stream;
24
25 import java.io.InputStream JavaDoc;
26 import java.io.OutputStream JavaDoc;
27 import java.io.IOException JavaDoc;
28
29 /**
30  * This interface allows to read/write the content of an object on a IO stream.
31  */

32 public interface Streamable {
33   /**
34    * The object implements the writeTo method to write its contents to
35    * the output stream.
36    *
37    * @param os the stream to write the object to
38    */

39   public void writeTo(OutputStream JavaDoc os) throws IOException JavaDoc;
40
41   /**
42    * The object implements the readFrom method to restore its contents from
43    * the input stream.
44    *
45    * @param is the stream to read data from in order to restore the object
46    */

47   public void readFrom(InputStream JavaDoc is) throws IOException JavaDoc;
48 }
49
Popular Tags