KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > message > codec > CodecInputOutput


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
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 of the License, or (at your option) 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 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq
22  * Contributor(s):
23  */

24
25 package org.objectweb.dream.message.codec;
26
27 import java.io.IOException JavaDoc;
28
29 /**
30  * Gathers an input and an output used by {@link MessageCodec}.
31  */

32 public interface CodecInputOutput
33 {
34   /**
35    * Returns an input that can be used to read data to decode.
36    *
37    * @return an input.
38    * @throws IOException if the input can't be created.
39    */

40   Object JavaDoc getInput() throws IOException JavaDoc;
41
42   /**
43    * Set the input. This is usefull for {@link MessageCodec }that use
44    * specialized input. If this object is used to decode another message, the
45    * codec can reuse its specialized input.
46    *
47    * @param input the new input.
48    */

49   void setInput(Object JavaDoc input);
50
51   /**
52    * Returns an output that can be used to write encoded data.
53    *
54    * @return an output.
55    * @throws IOException if the output can't be created.
56    */

57   Object JavaDoc getOutput() throws IOException JavaDoc;
58
59   /**
60    * Set the output. This is usefull for {@link MessageCodec }that use
61    * specialized output. If this object is used to decode another message, the
62    * codec can reuse its specialized output.
63    *
64    * @param output the new output.
65    */

66   void setOutput(Object JavaDoc output);
67
68 }
Popular Tags