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.util.ArrayList;
+import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.Map;
import java.util.UnknownFormatConversionException;
+import be.nikiroo.utils.ImageUtils;
+
/**
* 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>
+ * </ul>
*
* @author niki
*/
static {
customTypes = new HashMap<String, CustomSerializer>();
- // TODO: add "default" custom serialisers if any (Bitmap?)
// Array types:
customTypes.put("[]", new CustomSerializer() {
}
}
});
+
+ // Images (this is currently the only supported image type by default)
+ customTypes.put("java.awt.image.BufferedImage", new CustomSerializer() {
+ @Override
+ protected String toString(Object value) {
+ try {
+ return ImageUtils.toBase64((BufferedImage) value);
+ } catch (IOException e) {
+ throw new UnknownFormatConversionException(e.getMessage());
+ }
+ }
+
+ @Override
+ protected String getType() {
+ return "java.awt.image.BufferedImage";
+ }
+
+ @Override
+ protected Object fromString(String content) {
+ try {
+ return ImageUtils.fromBase64(content);
+ } catch (IOException e) {
+ throw new UnknownFormatConversionException(e.getMessage());
+ }
+ }
+ });
}
/**
for (Field field : fields) {
field.setAccessible(true);
- if (field.getName().startsWith("this$")) {
+ if (field.getName().startsWith("this$")
+ || field.isSynthetic()
+ || (field.getModifiers() & Modifier.STATIC) == Modifier.STATIC) {
// Do not keep this links of nested classes
+ // Do not keep synthetic fields
+ // Do not keep final fields
continue;
}
builder.append("\n}");
}
- // return true if encoded (supported)
+ /**
+ * Encode the object into the given builder if possible (if supported).
+ *
+ * @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);
+ 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);
builder.append(value).append('F');
} else if (value instanceof Double) {
builder.append(value).append('d');
+ } else if (value instanceof Enum) {
+ String type = value.getClass().getCanonicalName();
+ builder.append(type).append(".").append(((Enum<?>) value).name())
+ .append(";");
} else {
return false;
}
return true;
}
+ /**
+ * Decode the data into an equivalent source object.
+ *
+ * @param encodedValue
+ * the encoded data, cannot be NULL
+ *
+ * @return the object (can be NULL for NULL encoded values)
+ *
+ * @throws UnknownFormatConversionException
+ * if the content cannot be converted
+ */
static Object decode(String encodedValue) {
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);
- } else {
+ try {
+ 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 UnknownFormatConversionException(
"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 {
+ 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 {
- return Integer.parseInt(encodedValue);
+ } catch (Exception e) {
+ if (e instanceof UnknownFormatConversionException) {
+ throw (UnknownFormatConversionException) e;
+ }
+ throw new UnknownFormatConversionException(e.getMessage());
}
}
return clazz;
}
+ @SuppressWarnings({ "unchecked", "rawtypes" })
+ private static Enum<?> decodeEnum(String escaped) {
+ // escaped: be.xxx.EnumType.VALUE;
+ int pos = escaped.lastIndexOf(".");
+ String type = escaped.substring(0, pos);
+ String name = escaped.substring(pos + 1, escaped.length() - 1);
+
+ try {
+ return Enum.valueOf((Class<Enum>) getClass(type), name);
+ } catch (Exception e) {
+ throw new UnknownFormatConversionException("Unknown enum: <" + type
+ + "> " + name);
+ }
+ }
+
// aa bb -> "aa\tbb"
private static void encodeString(StringBuilder builder, String raw) {
builder.append('\"');
git://git.nikiroo.be / nikiroo-utils.git / blobdiff