Serial: enums and BufferedImages
[nikiroo-utils.git] / src / be / nikiroo / utils / serial / SerialUtils.java
index 49817b250f4f170f3547e62355fa3a7b7b4023c3..c28faeddebd86cd783e4924460aa01cb749f4b83 100644 (file)
@@ -1,10 +1,17 @@
 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.util.HashMap;
 import java.util.Map;
+import java.util.UnknownFormatConversionException;
+
+import be.nikiroo.utils.StringUtils;
 
 /**
  * Small class to help with serialisation.
@@ -19,7 +26,88 @@ public class SerialUtils {
 
        static {
                customTypes = new HashMap<String, CustomSerializer>();
-               // TODO: add "default" custom serialisers if any (Bitmap?)
+
+               // Array types:
+               customTypes.put("[]", new CustomSerializer() {
+                       @Override
+                       protected String toString(Object value) {
+                               String type = value.getClass().getCanonicalName();
+                               type = type.substring(0, type.length() - 2); // remove the []
+
+                               StringBuilder builder = new StringBuilder();
+                               builder.append(type).append("\n");
+                               try {
+                                       for (int i = 0; true; i++) {
+                                               Object item = Array.get(value, i);
+                                               // encode it normally if direct value
+                                               if (!SerialUtils.encode(builder, item)) {
+                                                       try {
+                                                               // use ZIP: if not
+                                                               builder.append(new Exporter().append(item)
+                                                                               .toString(true));
+                                                       } catch (NotSerializableException e) {
+                                                               throw new UnknownFormatConversionException(e
+                                                                               .getMessage());
+                                                       }
+                                               }
+                                               builder.append("\n");
+                                       }
+                               } catch (ArrayIndexOutOfBoundsException e) {
+                                       // Done.
+                               }
+
+                               return builder.toString();
+                       }
+
+                       @Override
+                       protected String getType() {
+                               return "[]";
+                       }
+
+                       @Override
+                       protected Object fromString(String content) {
+                               String[] tab = content.split("\n");
+
+                               try {
+                                       Object array = Array.newInstance(
+                                                       SerialUtils.getClass(tab[0]), tab.length - 1);
+                                       for (int i = 1; i < tab.length; i++) {
+                                               Object value = new Importer().read(tab[i]).getValue();
+                                               Array.set(array, i - 1, value);
+                                       }
+
+                                       return array;
+                               } catch (Exception e) {
+                                       throw new UnknownFormatConversionException(e.getMessage());
+                               }
+                       }
+               });
+
+               // 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 StringUtils.fromImage((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 StringUtils.toImage(content);
+                               } catch (IOException e) {
+                                       throw new UnknownFormatConversionException(e.getMessage());
+                               }
+                       }
+               });
        }
 
        /**
@@ -122,32 +210,41 @@ public class SerialUtils {
                        }
                }
 
-               builder.append("{\nREF ").append(type).append("@").append(id);
-               try {
-                       for (Field field : fields) {
-                               field.setAccessible(true);
+               builder.append("{\nREF ").append(type).append("@").append(id)
+                               .append(":");
+               if (!encode(builder, o)) { // check if direct value
+                       try {
+                               for (Field field : fields) {
+                                       field.setAccessible(true);
 
-                               if (field.getName().startsWith("this$")) {
-                                       // Do not keep this links of nested classes
-                                       continue;
-                               }
+                                       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");
-                               builder.append(field.getName());
-                               builder.append(":");
-                               Object value;
+                                       builder.append("\n");
+                                       builder.append(field.getName());
+                                       builder.append(":");
+                                       Object value;
 
-                               value = field.get(o);
+                                       value = field.get(o);
 
-                               if (!encode(builder, value)) {
-                                       builder.append("\n");
-                                       append(builder, value, map);
+                                       if (!encode(builder, value)) {
+                                               builder.append("\n");
+                                               append(builder, value, map);
+                                       }
                                }
+                       } catch (IllegalArgumentException e) {
+                               e.printStackTrace(); // should not happen (see
+                                                                               // setAccessible)
+                       } catch (IllegalAccessException e) {
+                               e.printStackTrace(); // should not happen (see
+                                                                               // setAccessible)
                        }
-               } catch (IllegalArgumentException e) {
-                       e.printStackTrace(); // should not happen (see setAccessible)
-               } catch (IllegalAccessException e) {
-                       e.printStackTrace(); // should not happen (see setAccessible)
                }
                builder.append("\n}");
        }
@@ -156,6 +253,8 @@ public class SerialUtils {
        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 (customTypes.containsKey(value.getClass().getCanonicalName())) {
                        customTypes.get(value.getClass().getCanonicalName())//
                                        .encode(builder, value);
@@ -166,7 +265,7 @@ public class SerialUtils {
                } else if (value instanceof Byte) {
                        builder.append(value).append('b');
                } else if (value instanceof Character) {
-                       encodeString(builder, (String) value);
+                       encodeString(builder, "" + value);
                        builder.append('c');
                } else if (value instanceof Short) {
                        builder.append(value).append('s');
@@ -178,6 +277,10 @@ public class SerialUtils {
                        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;
                }
@@ -197,7 +300,7 @@ public class SerialUtils {
                        if (customTypes.containsKey(type)) {
                                return customTypes.get(type).decode(encodedValue);
                        } else {
-                               throw new java.util.UnknownFormatConversionException(
+                               throw new UnknownFormatConversionException(
                                                "Unknown custom type: " + type);
                        }
                } else if (encodedValue.equals("NULL") || encodedValue.equals("null")) {
@@ -220,6 +323,8 @@ public class SerialUtils {
                        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);
                }
@@ -275,6 +380,22 @@ public class SerialUtils {
                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) {
+                       e.printStackTrace();
+                       throw new UnknownFormatConversionException("Unknown enum: <" + type
+                                       + "> " + name);
+               }
+       }
+
        // aa bb -> "aa\tbb"
        private static void encodeString(StringBuilder builder, String raw) {
                builder.append('\"');