MessageCodec


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  ;
28  
29  import org.objectweb.dream.message.Message;
30  
31  /**
32   * Message managment interface to encode/decode messages on
33   * {@link CodecInputOutput}.
34   */
35  public interface MessageCodec
36  {
37  
38    /** The commonly used name of refer to this interface. */
39    String   ITF_NAME = "message-codec";
40  
41    /**
42     * Encodes the given message on the given stream. This method is responsible
43     * to encode the given message and its sub messages recursivly.
44     * 
45     * @param cio contains the input on which the message is encoded.
46     * @param message a message to serialize.
47     * @throws IOException if an error occurs during the serialization.
48     */
49    void encode(CodecInputOutput cio, Message message) throws IOException  ;
50  
51    /**
52     * Deserializes a message from the given stream. This method is responsible to
53     * decode the given message and its sub messages recursivly.
54     * 
55     * @param cio contains the output on which the message is decoded.
56     * @return a message
57     * @throws IOException if an error occurs during the deserialization.
58     */
59    Message decode(CodecInputOutput cio) throws IOException  ;
60  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags