Changeset 83 for trunk/src/main/java/omq/common/util/Serializers/ISerializer.java

Timestamp:

07/08/13 13:29:24 (11 years ago)

Author:

stoda

Message:

J

File:

• trunk/src/main/java/omq/common/util/Serializers/ISerializer.java (modified) (2 diffs)

trunk/src/main/java/omq/common/util/Serializers/ISerializer.java

@@ -7 +7 @@
 
 /**
+ * An ISerializer object can serialize any kind of objects and deserialize
+ * Requests and Responses.
  * 
  * @author Sergi Toda <sergi.toda@estudiants.urv.cat>
@@ -12 +14 @@
  */
 public interface ISerializer {
+        /**
+         * Serialize
+         * 
+         * @param obj
+         *            - object to serialize
+         * @return objectSerialized
+         * @throws SerializerException
+         *             - If the serialization failed
+         */
         public byte[] serialize(Object obj) throws SerializerException;
 
+        /**
+         * Deserialize a Request
+         * 
+         * @param bytes
+         *            - serialized request
+         * @param obj
+         *            - remoteObject which is receiving requests
+         * @return request
+         * @throws SerializerException
+         *             - If the serialization failed
+         */
         public Request deserializeRequest(byte[] bytes, RemoteObject obj) throws SerializerException;
 
+        /**
+         * Deserialize a Response
+         * 
+         * @param bytes
+         *            serialized response
+         * @param type
+         *            - return type expected
+         * @return response
+         * @throws SerializerException
+         *             - If the serialization failed
+         */
         public Response deserializeResponse(byte[] bytes, Class<?> type) throws SerializerException;
 }