diff artifacts/src/main/java/de/intevation/artifacts/ArtifactSerializer.java @ 78:55eefe63a777

Repaired the javadoc stuff for almost all artifact interfaces. artifacts/trunk@760 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 11 Mar 2010 10:53:59 +0000
parents 48d1a9a082c2
children 78263e910675
line wrap: on
line diff
--- a/artifacts/src/main/java/de/intevation/artifacts/ArtifactSerializer.java	Sun Feb 21 23:05:32 2010 +0000
+++ b/artifacts/src/main/java/de/intevation/artifacts/ArtifactSerializer.java	Thu Mar 11 10:53:59 2010 +0000
@@ -7,7 +7,18 @@
  */
 public interface ArtifactSerializer
 {
+    /**
+     * Restores an artifact from an array of bytes.
+     * @param bytes the persistent representation of the artifact.
+     * @return The de-serialized artifact or null if there was an error.
+     */
     Artifact fromBytes(byte [] bytes);
+    /**
+     * Brings an artifact to a persistent form in form of a byte array.
+     * @param artifact The artifact to be serialized.
+     * @return the byte array representation of the artifact or null
+     * if there was an error.
+     */
     byte []  toBytes(Artifact artifact);
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8:

http://dive4elements.wald.intevation.org