package be.nikiroo.utils.serial;
-import java.awt.image.BufferedImage;
import java.io.IOException;
import java.io.NotSerializableException;
import java.lang.reflect.Array;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
+import java.net.URL;
+import java.util.ArrayList;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
import java.util.UnknownFormatConversionException;
-import be.nikiroo.utils.ImageUtils;
+import be.nikiroo.utils.Image;
/**
* Small class to help with serialisation.
* <p>
* Note that we do not support inner classes (but we do support nested classes)
* and all objects require an empty constructor to be deserialised.
+ * <p>
+ * It is possible to add support to custom types (both the encoder and the
+ * decoder will require the custom classes) -- see {@link CustomSerializer}.
+ * <p>
+ * Default supported types are:
+ * <ul>
+ * <li>NULL (as a null value)</li>
+ * <li>String</li>
+ * <li>Boolean</li>
+ * <li>Byte</li>
+ * <li>Character</li>
+ * <li>Short</li>
+ * <li>Long</li>
+ * <li>Float</li>
+ * <li>Double</li>
+ * <li>Integer</li>
+ * <li>Enum (any enum whose name and value is known by the caller)</li>
+ * <li>java.awt.image.BufferedImage (as a {@link CustomSerializer})</li>
+ * <li>An array of the above (as a {@link CustomSerializer})</li>
+ * <li>URL</li>
+ * </ul>
*
* @author niki
*/
if (!SerialUtils.encode(builder, item)) {
try {
// use ZIP: if not
- builder.append(new Exporter().append(item)
- .toString(true));
+ new Exporter().append(item).appendTo(builder,
+ true, false);
} catch (NotSerializableException e) {
throw new UnknownFormatConversionException(e
.getMessage());
}
@Override
- protected Object fromString(String content) {
+ protected Object fromString(String content) throws IOException {
String[] tab = content.split("\n");
try {
return array;
} catch (Exception e) {
- throw new UnknownFormatConversionException(e.getMessage());
+ if (e instanceof IOException) {
+ throw (IOException) e;
+ }
+ throw new IOException(e.getMessage());
}
}
});
- // Images (this is currently the only supported image type by default)
- customTypes.put("java.awt.image.BufferedImage", new CustomSerializer() {
+ // URL:
+ customTypes.put("java.net.URL", new CustomSerializer() {
@Override
protected String toString(Object value) {
- try {
- return ImageUtils.toBase64((BufferedImage) value);
- } catch (IOException e) {
- throw new UnknownFormatConversionException(e.getMessage());
+ if (value != null) {
+ return ((URL) value).toString();
}
+ return null;
+ }
+
+ @Override
+ protected Object fromString(String content) throws IOException {
+ if (content != null) {
+ return new URL(content);
+ }
+ return null;
}
@Override
protected String getType() {
- return "java.awt.image.BufferedImage";
+ return "java.net.URL";
+ }
+ });
+
+ // Images (this is currently the only supported image type by default)
+ customTypes.put("be.nikiroo.utils.Image", new CustomSerializer() {
+ @Override
+ protected String toString(Object value) {
+ return ((Image) value).toBase64();
+ }
+
+ @Override
+ protected String getType() {
+ return "be.nikiroo.utils.Image";
}
@Override
protected Object fromString(String content) {
try {
- return ImageUtils.fromBase64(content);
+ return new Image(content);
} catch (IOException e) {
throw new UnknownFormatConversionException(e.getMessage());
}
public static Object createObject(String type)
throws ClassNotFoundException, NoSuchMethodException {
+ String desc = null;
try {
Class<?> clazz = getClass(type);
String className = clazz.getName();
- Object[] args = null;
+ List<Object> args = new ArrayList<Object>();
+ List<Class<?>> classes = new ArrayList<Class<?>>();
Constructor<?> ctor = null;
if (className.contains("$")) {
- Object javaParent = createObject(className.substring(0,
- className.lastIndexOf('$')));
- args = new Object[] { javaParent };
- ctor = clazz.getDeclaredConstructor(new Class[] { javaParent
- .getClass() });
+ for (String parentName = className.substring(0,
+ className.lastIndexOf('$'));; parentName = parentName
+ .substring(0, parentName.lastIndexOf('$'))) {
+ Object parent = createObject(parentName);
+ args.add(parent);
+ classes.add(parent.getClass());
+
+ if (!parentName.contains("$")) {
+ break;
+ }
+ }
+
+ // Better error description in case there is no empty
+ // constructor:
+ desc = "";
+ String end = "";
+ for (Class<?> parent = clazz; parent != null
+ && !parent.equals(Object.class); parent = parent
+ .getSuperclass()) {
+ if (!desc.isEmpty()) {
+ desc += " [:";
+ end += "]";
+ }
+ desc += parent;
+ }
+ desc += end;
+ //
+
+ try {
+ ctor = clazz.getDeclaredConstructor(classes
+ .toArray(new Class[] {}));
+ } catch (NoSuchMethodException nsme) {
+ // TODO: it seems e do not always need a parameter for each
+ // level, so we currently try "ALL" levels or "FIRST" level
+ // only -> we should check the actual rule and use it
+ ctor = clazz.getDeclaredConstructor(classes.get(0));
+ Object firstParent = args.get(0);
+ args.clear();
+ args.add(firstParent);
+ }
+ desc = null;
} else {
- args = new Object[] {};
ctor = clazz.getDeclaredConstructor();
}
ctor.setAccessible(true);
- return ctor.newInstance(args);
+ return ctor.newInstance(args.toArray());
} catch (ClassNotFoundException e) {
throw e;
} catch (NoSuchMethodException e) {
+ if (desc != null) {
+ throw new NoSuchMethodException("Empty constructor not found: "
+ + desc);
+ }
throw e;
} catch (Exception e) {
throw new NoSuchMethodException("Cannot instantiate: " + type);
fields = o.getClass().getDeclaredFields();
type = o.getClass().getCanonicalName();
if (type == null) {
- throw new NotSerializableException(
- String.format(
- "Cannot find the class for this object: %s (it could be an inner class, which is not supported)",
- o));
+ // Anonymous inner classes support
+ type = o.getClass().getName();
}
id = Integer.toString(hash);
if (map.containsKey(hash)) {
builder.append("\n}");
}
- // return true if encoded (supported)
+ /**
+ * Encode the object into the given builder if possible and if supported.
+ * <p>
+ * A supported object in this context means an object we can directly
+ * encode, like an Integer or a String. Custom objects and arrays are also
+ * considered supported, but <b>compound objects are not supported here</b>.
+ * <p>
+ * For compound objects, you should use {@link Exporter}.
+ *
+ * @param builder
+ * the builder to append to
+ * @param value
+ * the object to encode (can be NULL, which will be encoded)
+ *
+ * @return TRUE if success, FALSE if not (the content of the builder won't
+ * be changed in case of failure)
+ */
static boolean encode(StringBuilder builder, Object value) {
if (value == null) {
builder.append("NULL");
- } else if (value.getClass().getCanonicalName().endsWith("[]")) {
- customTypes.get("[]").encode(builder, value);
+ } else if (value.getClass().getSimpleName().endsWith("[]")) {
+ // Simple name does support [] suffix and do not return NULL for
+ // inner anonymous classes
+ return customTypes.get("[]").encode(builder, value);
} else if (customTypes.containsKey(value.getClass().getCanonicalName())) {
- customTypes.get(value.getClass().getCanonicalName())//
+ return customTypes.get(value.getClass().getCanonicalName())//
.encode(builder, value);
} else if (value instanceof String) {
encodeString(builder, (String) value);
return true;
}
- static Object decode(String encodedValue) {
- String cut = "";
- if (encodedValue.length() > 1) {
- cut = encodedValue.substring(0, encodedValue.length() - 1);
- }
+ /**
+ * Decode the data into an equivalent supported source object.
+ * <p>
+ * A supported object in this context means an object we can directly
+ * encode, like an Integer or a String. Custom objects and arrays are also
+ * considered supported, but <b>compound objects are not supported here</b>.
+ * <p>
+ * For compound objects, you should use {@link Importer}.
+ *
+ * @param encodedValue
+ * the encoded data, cannot be NULL
+ *
+ * @return the object (can be NULL for NULL encoded values)
+ *
+ * @throws IOException
+ * if the content cannot be converted
+ */
+ static Object decode(String encodedValue) throws IOException {
+ try {
+ String cut = "";
+ if (encodedValue.length() > 1) {
+ cut = encodedValue.substring(0, encodedValue.length() - 1);
+ }
- if (CustomSerializer.isCustom(encodedValue)) {
- // custom:TYPE_NAME:"content is String-encoded"
- String type = CustomSerializer.typeOf(encodedValue);
- if (customTypes.containsKey(type)) {
- return customTypes.get(type).decode(encodedValue);
+ if (CustomSerializer.isCustom(encodedValue)) {
+ // custom:TYPE_NAME:"content is String-encoded"
+ String type = CustomSerializer.typeOf(encodedValue);
+ if (customTypes.containsKey(type)) {
+ return customTypes.get(type).decode(encodedValue);
+ }
+ throw new IOException("Unknown custom type: " + type);
+ } else if (encodedValue.equals("NULL")
+ || encodedValue.equals("null")) {
+ return null;
+ } else if (encodedValue.endsWith("\"")) {
+ return decodeString(encodedValue);
+ } else if (encodedValue.equals("true")) {
+ return true;
+ } else if (encodedValue.equals("false")) {
+ return false;
+ } else if (encodedValue.endsWith("b")) {
+ return Byte.parseByte(cut);
+ } else if (encodedValue.endsWith("c")) {
+ return decodeString(cut).charAt(0);
+ } else if (encodedValue.endsWith("s")) {
+ return Short.parseShort(cut);
+ } else if (encodedValue.endsWith("L")) {
+ return Long.parseLong(cut);
+ } else if (encodedValue.endsWith("F")) {
+ return Float.parseFloat(cut);
+ } else if (encodedValue.endsWith("d")) {
+ return Double.parseDouble(cut);
+ } else if (encodedValue.endsWith(";")) {
+ return decodeEnum(encodedValue);
} else {
- throw new UnknownFormatConversionException(
- "Unknown custom type: " + type);
+ return Integer.parseInt(encodedValue);
}
- } else if (encodedValue.equals("NULL") || encodedValue.equals("null")) {
- return null;
- } else if (encodedValue.endsWith("\"")) {
- return decodeString(encodedValue);
- } else if (encodedValue.equals("true")) {
- return true;
- } else if (encodedValue.equals("false")) {
- return false;
- } else if (encodedValue.endsWith("b")) {
- return Byte.parseByte(cut);
- } else if (encodedValue.endsWith("c")) {
- return decodeString(cut).charAt(0);
- } else if (encodedValue.endsWith("s")) {
- return Short.parseShort(cut);
- } else if (encodedValue.endsWith("L")) {
- return Long.parseLong(cut);
- } else if (encodedValue.endsWith("F")) {
- return Float.parseFloat(cut);
- } else if (encodedValue.endsWith("d")) {
- return Double.parseDouble(cut);
- } else if (encodedValue.endsWith(";")) {
- return decodeEnum(encodedValue);
- } else {
- return Integer.parseInt(encodedValue);
+ } catch (Exception e) {
+ if (e instanceof IOException) {
+ throw (IOException) e;
+ }
+ throw new IOException(e.getMessage());
}
}
try {
return Enum.valueOf((Class<Enum>) getClass(type), name);
} catch (Exception e) {
- e.printStackTrace();
throw new UnknownFormatConversionException("Unknown enum: <" + type
+ "> " + name);
}
}
}
- return builder.substring(1, builder.length() - 1).toString();
+ return builder.substring(1, builder.length() - 1);
}
}