X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fserial%2FExporter.java;h=d5f3a5fdc72e47219f3a70a0fb15c0480bf72045;hb=a359464fcf59af8abc6f69ae0e88e42adc6018df;hp=8b04111979ddaa751548d11b56f7572381cc1fe2;hpb=db31c35860081535d6e7ddc83ab4af573bb0522e;p=nikiroo-utils.git

diff --git a/src/be/nikiroo/utils/serial/Exporter.java b/src/be/nikiroo/utils/serial/Exporter.java
index 8b04111..d5f3a5f 100644
--- a/src/be/nikiroo/utils/serial/Exporter.java
+++ b/src/be/nikiroo/utils/serial/Exporter.java
@@ -1,5 +1,6 @@
 package be.nikiroo.utils.serial;
 
+import java.io.IOException;
 import java.io.NotSerializableException;
 import java.util.HashMap;
 import java.util.Map;
@@ -18,41 +19,121 @@ 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
-	public String toString(Boolean zip) {
-		if (zip == null) {
-			zip = builder.length() > 128;
+	/**
+	 * Append the exported items in a serialised form into the given
+	 * {@link StringBuilder}.
+	 * 
+	 * @param toBuilder
+	 *            the {@link StringBuilder}
+	 * @param b64
+	 *            TRUE to have BASE64-coded content, FALSE to have raw content,
+	 *            NULL to let the system decide
+	 * @param zip
+	 *            TRUE to zip the BASE64 output if the output is indeed in
+	 *            BASE64 format, FALSE not to
+	 */
+	public void appendTo(StringBuilder toBuilder, Boolean b64, boolean zip) {
+		if (b64 == null && builder.length() < 128) {
+			b64 = false;
 		}
 
-		if (zip) {
-			return "ZIP:" + StringUtils.zip64(builder.toString());
-		} else {
-			return builder.toString();
+		if (b64 != null || b64) {
+			try {
+				String zipped = StringUtils.base64(builder.toString(), zip);
+				if (b64 != null || zipped.length() < builder.length() - 4) {
+					toBuilder.append(zip ? "ZIP:" : "B64:");
+					toBuilder.append(zipped);
+					return;
+				}
+			} catch (IOException e) {
+				throw new RuntimeException(
+						"Base64 conversion of data failed, maybe not enough memory?",
+						e);
+			}
 		}
+
+		toBuilder.append(builder);
+	}
+
+	/**
+	 * The exported items in a serialised form.
+	 * 
+	 * @deprecated use {@link Exporter#toString(Boolean, boolean)} instead
+	 * 
+	 * @param zip
+	 *            TRUE to have zipped (and BASE64-coded) content, FALSE to have
+	 *            raw content, NULL to let the system decide
+	 * 
+	 * @return the items currently in this {@link Exporter}
+	 */
+	@Deprecated
+	public String toString(Boolean zip) {
+		return toString(zip, zip == null || zip);
 	}
 
 	/**
 	 * The exported items in a serialised form.
 	 * 
-	 * @return the items currently in this {@link Exporter}.
+	 * @param b64
+	 *            TRUE to have BASE64-coded content, FALSE to have raw content,
+	 *            NULL to let the system decide
+	 * @param zip
+	 *            TRUE to zip the BASE64 output if the output is indeed in
+	 *            BASE64 format, FALSE not to
+	 * 
+	 * @return the items currently in this {@link Exporter}
+	 */
+	public String toString(Boolean b64, boolean zip) {
+		StringBuilder toBuilder = new StringBuilder();
+		appendTo(toBuilder, b64, zip);
+		return toBuilder.toString();
+	}
+
+	/**
+	 * The exported items in a serialised form (possibly BASE64-coded, possibly
+	 * zipped).
+	 * 
+	 * @return the items currently in this {@link Exporter}
 	 */
 	@Override
 	public String toString() {
-		return toString(null);
+		return toString(null, true);
 	}
 }
\ No newline at end of file