jDoc, tests, Server fixes

[nikiroo-utils.git] / src / be / nikiroo / utils / serial / Exporter.java

diff --git a/src/be/nikiroo/utils/serial/Exporter.java b/src/be/nikiroo/utils/serial/Exporter.java
index 8b522e9556054dea43572f6a5e4226f738e116b8..90939880f6f29e0e2ba1488f274db1daed932f7b 100644 (file)
--- a/src/be/nikiroo/utils/serial/Exporter.java
+++ b/src/be/nikiroo/utils/serial/Exporter.java
@@ -18,22 +18,52 @@ public class Exporter {
        private Map<Integer, Object> map;
        private StringBuilder builder;
 
+       /**
+        * Create a new {@link Exporter}.
+        */
        public Exporter() {
                map = new HashMap<Integer, Object>();
                builder = new StringBuilder();
        }
 
+       /**
+        * Serialise the given object and add it to the list.
+        * <p>
+        * <b>Important: </b>If the operation fails (with a
+        * {@link NotSerializableException}), the {@link Exporter} will be corrupted
+        * (will contain bad, most probably not importable data).
+        * 
+        * @param o
+        *            the object to serialise
+        * @return this (for easier appending of multiple values)
+        * 
+        * @throws NotSerializableException
+        *             if the object cannot be serialised (in this case, the
+        *             {@link Exporter} can contain bad, most probably not
+        *             importable data)
+        */
        public Exporter append(Object o) throws NotSerializableException {
                SerialUtils.append(builder, o, map);
                return this;
        }
 
+       /**
+        * Clear the current content.
+        */
        public void clear() {
                builder.setLength(0);
                map.clear();
        }
 
-       // null = auto
+       /**
+        * The exported items in a serialised form.
+        * 
+        * @param zip
+        *            TRUE to have zipped content, FALSE to have raw content, NULL
+        *            to let the system decide
+        * 
+        * @return the items currently in this {@link Exporter}
+        */
        public String toString(Boolean zip) {
                if (zip == null) {
                        zip = builder.length() > 128;
@@ -47,9 +77,9 @@ public class Exporter {
        }
 
        /**
-        * The exported items in a serialised form.
+        * The exported items in a serialised form (possibly zipped).
         * 
-        * @return the items currently in this {@link Exporter}.
+        * @return the items currently in this {@link Exporter}
         */
        @Override
        public String toString() {