X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fserial%2FCustomSerializer.java;h=e58ccf2af5945eab2ba4b508bd9d04c9213c56f1;hb=12b90437b5f22c2ae6e9b9b14c3b62b60f6143e5;hp=496fcb16baceaa3123386f612feaa899aff52f6a;hpb=d251f3dd38a8f9d369a7cf627185eacc4f66ece5;p=nikiroo-utils.git diff --git a/src/be/nikiroo/utils/serial/CustomSerializer.java b/src/be/nikiroo/utils/serial/CustomSerializer.java index 496fcb1..e58ccf2 100644 --- a/src/be/nikiroo/utils/serial/CustomSerializer.java +++ b/src/be/nikiroo/utils/serial/CustomSerializer.java @@ -4,10 +4,7 @@ import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; -import be.nikiroo.utils.IOUtils; import be.nikiroo.utils.streams.BufferedInputStream; -import be.nikiroo.utils.streams.NextableInputStream; -import be.nikiroo.utils.streams.NextableInputStreamStep; import be.nikiroo.utils.streams.ReplaceInputStream; import be.nikiroo.utils.streams.ReplaceOutputStream; @@ -78,7 +75,12 @@ public abstract class CustomSerializer { protected abstract String getType(); /** - * Encode the object into the given {@link OutputStream}. + * Encode the object into the given {@link OutputStream}, i.e., generate the + * ENCODED_VALUE part. + *
+ * Use whatever scheme you wish, the system shall ensure that the content is + * correctly encoded and that you will receive the same content at decode + * time. * * @param out * the builder to append to @@ -105,6 +107,14 @@ public abstract class CustomSerializer { /** * Decode the value back into the supported object type. + *
+ * We do not expect the full content here but only: + *