Merge branch '125-flexmap' into dev

Author: greenrobot-team

objectbox-java/src/main/java/io/objectbox/Property.java

@@ -443,7 +443,7 @@ private void checkNotStringArray() {
     }
 
     /**
-     * For a String array or String-key map property, matches if at least one element equals the given value
+     * For a String array, list or String-key map property, matches if at least one element equals the given value
      * using {@link StringOrder#CASE_SENSITIVE StringOrder#CASE_SENSITIVE}.
      *
      * @see #containsElement(String, StringOrder)

objectbox-java/src/main/java/io/objectbox/converter/FlexMapConverter.java renamed to objectbox-java/src/main/java/io/objectbox/converter/FlexObjectConverter.java

@@ -10,25 +10,31 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.concurrent.atomic.AtomicReference;
 
 /**
- * Converts between {@link Map} properties and byte arrays using FlexBuffers.
+ * Converts between {@link Object} properties and byte arrays using FlexBuffers.
  * <p>
- * All keys must have the same type (see {@link #convertToKey(String)}),
- * value types are limited to those supported by FlexBuffers.
+ * Types are limited to those supported by FlexBuffers, including that map keys must be {@link String}.
+ * (There are subclasses available that auto-convert {@link Integer} and {@link Long} key maps,
+ * see {@link #convertToKey}.)
  * <p>
  * If any item requires 64 bits for storage in the FlexBuffers Map/Vector (a large Long, a Double)
- * all integers are restored as Long, otherwise Integer.
+ * all integers are restored as {@link Long}, otherwise {@link Integer}.
+ * So e.g. when storing only a {@link Long} value of {@code 1L}, the value restored from the
+ * database will be of type {@link Integer}.
+ * (There are subclasses available that always restore as {@link Long}, see {@link #shouldRestoreAsLong}.)
+ * <p>
+ * Values of type {@link Float} are always restored as {@link Double}.
+ * Cast to {@link Float} to obtain the original value.
  */
-public abstract class FlexMapConverter implements PropertyConverter<Map<Object, Object>, byte[]> {
+public class FlexObjectConverter implements PropertyConverter<Object, byte[]> {
 
     private static final AtomicReference<FlexBuffersBuilder> cachedBuilder = new AtomicReference<>();
 
     @Override
-    public byte[] convertToDatabaseValue(Map<Object, Object> map) {
-        if (map == null) return null;
+    public byte[] convertToDatabaseValue(Object value) {
+        if (value == null) return null;
 
         FlexBuffersBuilder builder = cachedBuilder.getAndSet(null);
         if (builder == null) {
@@ -40,7 +46,7 @@ public byte[] convertToDatabaseValue(Map<Object, Object> map) {
             );
         }
 
-        addMap(builder, null, map);
+        addValue(builder, value);
 
         ByteBuffer buffer = builder.finish();
 
@@ -56,16 +62,59 @@ public byte[] convertToDatabaseValue(Map<Object, Object> map) {
         return out;
     }
 
+    private void addValue(FlexBuffersBuilder builder, Object value) {
+        if (value instanceof Map) {
+            //noinspection unchecked
+            addMap(builder, null, (Map<Object, Object>) value);
+        } else if (value instanceof List) {
+            //noinspection unchecked
+            addVector(builder, null, (List<Object>) value);
+        } else if (value instanceof String) {
+            builder.putString((String) value);
+        } else if (value instanceof Boolean) {
+            builder.putBoolean((Boolean) value);
+        } else if (value instanceof Byte) {
+            // Will always be restored as Integer.
+            builder.putInt(((Byte) value).intValue());
+        } else if (value instanceof Short) {
+            // Will always be restored as Integer.
+            builder.putInt(((Short) value).intValue());
+        } else if (value instanceof Integer) {
+            builder.putInt((Integer) value);
+        } else if (value instanceof Long) {
+            builder.putInt((Long) value);
+        } else if (value instanceof Float) {
+            builder.putFloat((Float) value);
+        } else if (value instanceof Double) {
+            builder.putFloat((Double) value);
+        } else if (value instanceof byte[]) {
+            builder.putBlob((byte[]) value);
+        } else {
+            throw new IllegalArgumentException(
+                    "Values of this type are not supported: " + value.getClass().getSimpleName());
+        }
+    }
+
+    /**
+     * Checks Java map key is of the expected type, otherwise throws.
+     */
+    protected void checkMapKeyType(Object rawKey) {
+        if (!(rawKey instanceof String)) {
+            throw new IllegalArgumentException("Map keys must be String");
+        }
+    }
+
     private void addMap(FlexBuffersBuilder builder, String mapKey, Map<Object, Object> map) {
         int mapStart = builder.startMap();
 
-        for (Entry<Object, Object> entry : map.entrySet()) {
+        for (Map.Entry<Object, Object> entry : map.entrySet()) {
+            Object rawKey = entry.getKey();
             Object value = entry.getValue();
-            if (entry.getKey() == null || value == null) {
+            if (rawKey == null || value == null) {
                 throw new IllegalArgumentException("Map keys or values must not be null");
             }
-
-            String key = entry.getKey().toString();
+            checkMapKeyType(rawKey);
+            String key = rawKey.toString();
             if (value instanceof Map) {
                 //noinspection unchecked
                 addMap(builder, key, (Map<Object, Object>) value);
@@ -76,6 +125,12 @@ private void addMap(FlexBuffersBuilder builder, String mapKey, Map<Object, Objec
                 builder.putString(key, (String) value);
             } else if (value instanceof Boolean) {
                 builder.putBoolean(key, (Boolean) value);
+            } else if (value instanceof Byte) {
+                // Will always be restored as Integer.
+                builder.putInt(key, ((Byte) value).intValue());
+            } else if (value instanceof Short) {
+                // Will always be restored as Integer.
+                builder.putInt(key, ((Short) value).intValue());
             } else if (value instanceof Integer) {
                 builder.putInt(key, (Integer) value);
             } else if (value instanceof Long) {
@@ -99,6 +154,9 @@ private void addVector(FlexBuffersBuilder builder, String vectorKey, List<Object
         int vectorStart = builder.startVector();
 
         for (Object item : list) {
+            if (item == null) {
+                throw new IllegalArgumentException("List elements must not be null");
+            }
             if (item instanceof Map) {
                 //noinspection unchecked
                 addMap(builder, null, (Map<Object, Object>) item);
@@ -109,6 +167,12 @@ private void addVector(FlexBuffersBuilder builder, String vectorKey, List<Object
                 builder.putString((String) item);
             } else if (item instanceof Boolean) {
                 builder.putBoolean((Boolean) item);
+            } else if (item instanceof Byte) {
+                // Will always be restored as Integer.
+                builder.putInt(((Byte) item).intValue());
+            } else if (item instanceof Short) {
+                // Will always be restored as Integer.
+                builder.putInt(((Short) item).intValue());
             } else if (item instanceof Integer) {
                 builder.putInt((Integer) item);
             } else if (item instanceof Long) {
@@ -129,20 +193,42 @@ private void addVector(FlexBuffersBuilder builder, String vectorKey, List<Object
     }
 
     @Override
-    public Map<Object, Object> convertToEntityProperty(byte[] databaseValue) {
+    public Object convertToEntityProperty(byte[] databaseValue) {
         if (databaseValue == null) return null;
 
-        FlexBuffers.Map map = FlexBuffers.getRoot(new ArrayReadWriteBuf(databaseValue, databaseValue.length)).asMap();
-
-        return buildMap(map);
+        FlexBuffers.Reference value = FlexBuffers.getRoot(new ArrayReadWriteBuf(databaseValue, databaseValue.length));
+        if (value.isMap()) {
+            return buildMap(value.asMap());
+        } else if (value.isVector()) {
+            return buildList(value.asVector());
+        } else if (value.isString()) {
+            return value.asString();
+        } else if (value.isBoolean()) {
+            return value.asBoolean();
+        } else if (value.isInt()) {
+            if (shouldRestoreAsLong(value)) {
+                return value.asLong();
+            } else {
+                return value.asInt();
+            }
+        } else if (value.isFloat()) {
+            // Always return as double; if original was float consumer can cast to obtain original value.
+            return value.asFloat();
+        } else if (value.isBlob()) {
+            return value.asBlob().getBytes();
+        } else {
+            throw new IllegalArgumentException("FlexBuffers type is not supported: " + value.getType());
+        }
     }
 
     /**
      * Converts a FlexBuffers string map key to the Java map key (e.g. String to Integer).
      * <p>
      * This required conversion restricts all keys (root and embedded maps) to the same type.
      */
-    abstract Object convertToKey(String keyValue);
+    Object convertToKey(String keyValue) {
+        return keyValue;
+    }
 
     /**
      * Returns true if the width in bytes stored in the private parentWidth field of FlexBuffers.Reference is 8.
@@ -190,7 +276,7 @@ private Map<Object, Object> buildMap(FlexBuffers.Map map) {
                     resultMap.put(key, value.asInt());
                 }
             } else if (value.isFloat()) {
-                // Always return as double; if original was float casting will give original value.
+                // Always return as double; if original was float consumer can cast to obtain original value.
                 resultMap.put(key, value.asFloat());
             } else if (value.isBlob()) {
                 resultMap.put(key, value.asBlob().getBytes());
@@ -230,7 +316,7 @@ private List<Object> buildList(FlexBuffers.Vector vector) {
                     list.add(item.asInt());
                 }
             } else if (item.isFloat()) {
-                // Always return as double; if original was float casting will give original value.
+                // Always return as double; if original was float consumer can cast to obtain original value.
                 list.add(item.asFloat());
             } else if (item.isBlob()) {
                 list.add(item.asBlob().getBytes());
@@ -242,5 +328,4 @@ private List<Object> buildList(FlexBuffers.Vector vector) {
 
         return list;
     }
-
 }

objectbox-java/src/main/java/io/objectbox/converter/IntegerFlexMapConverter.java

@@ -1,9 +1,17 @@
 package io.objectbox.converter;
 
 /**
- * Used to automatically convert {@code Map<Integer, V>}.
+ * Used to automatically convert {@code Map&lt;Integer, V&gt;}.
  */
-public class IntegerFlexMapConverter extends FlexMapConverter {
+public class IntegerFlexMapConverter extends FlexObjectConverter {
+
+    @Override
+    protected void checkMapKeyType(Object rawKey) {
+        if (!(rawKey instanceof Integer)) {
+            throw new IllegalArgumentException("Map keys must be Integer");
+        }
+    }
+
     @Override
     Integer convertToKey(String keyValue) {
         return Integer.valueOf(keyValue);

objectbox-java/src/main/java/io/objectbox/converter/IntegerLongMapConverter.java

@@ -3,7 +3,9 @@
 import io.objectbox.flatbuffers.FlexBuffers;
 
 /**
- * Used to automatically convert {@code Map<Integer, Long>}.
+ * Used to automatically convert {@code Map&lt;Integer, Long&gt;}.
+ * <p>
+ * Unlike {@link FlexObjectConverter} always restores integer map values as {@link Long}.
  */
 public class IntegerLongMapConverter extends IntegerFlexMapConverter {
     @Override

objectbox-java/src/main/java/io/objectbox/converter/LongFlexMapConverter.java

@@ -3,7 +3,15 @@
 /**
  * Used to automatically convert {@code Map<Long, V>}.
  */
-public class LongFlexMapConverter extends FlexMapConverter {
+public class LongFlexMapConverter extends FlexObjectConverter {
+
+    @Override
+    protected void checkMapKeyType(Object rawKey) {
+        if (!(rawKey instanceof Long)) {
+            throw new IllegalArgumentException("Map keys must be Long");
+        }
+    }
+
     @Override
     Object convertToKey(String keyValue) {
         return Long.valueOf(keyValue);

objectbox-java/src/main/java/io/objectbox/converter/LongLongMapConverter.java

@@ -3,7 +3,9 @@
 import io.objectbox.flatbuffers.FlexBuffers;
 
 /**
- * Used to automatically convert {@code Map<Long, Long>}.
+ * Used to automatically convert {@code Map&lt;Long, Long&gt;}.
+ * <p>
+ * Unlike {@link FlexObjectConverter} always restores integer map values as {@link Long}.
  */
 public class LongLongMapConverter extends LongFlexMapConverter {
     @Override

objectbox-java/src/main/java/io/objectbox/converter/StringFlexMapConverter.java

@@ -1,11 +1,7 @@
 package io.objectbox.converter;
 
 /**
- * Used to automatically convert {@code Map<String, V>}.
+ * Used to automatically convert {@code Map&lt;String, V&gt;}.
  */
-public class StringFlexMapConverter extends FlexMapConverter {
-    @Override
-    Object convertToKey(String keyValue) {
-        return keyValue;
-    }
+public class StringFlexMapConverter extends FlexObjectConverter {
 }

objectbox-java/src/main/java/io/objectbox/converter/StringLongMapConverter.java

@@ -3,7 +3,7 @@
 import io.objectbox.flatbuffers.FlexBuffers;
 
 /**
- * Used to automatically convert {@code Map<String, Long>}.
+ * Used to automatically convert {@code Map&lt;String, Long&gt;}.
  */
 public class StringLongMapConverter extends StringFlexMapConverter {
     @Override

objectbox-java/src/main/java/io/objectbox/query/QueryBuilder.java

@@ -771,7 +771,7 @@ public QueryBuilder<T> contains(Property<T> property, String value, StringOrder
     }
 
     /**
-     * For a String array or String-key map property, matches if at least one element equals the given value.
+     * For a String array, list or String-key map property, matches if at least one element equals the given value.
      */
     public QueryBuilder<T> containsElement(Property<T> property, String value, StringOrder order) {
         verifyHandle();

tests/objectbox-java-test/src/main/java/io/objectbox/TestEntity.java

@@ -52,6 +52,7 @@ public class TestEntity {
     /** In "real" entity would be annotated with @Unsigned. */
     private long simpleLongU;
     private Map<String, Object> stringObjectMap;
+    private Object flexProperty;
 
     transient boolean noArgsConstructorCalled;
 
@@ -66,7 +67,8 @@ public TestEntity(long id) {
     public TestEntity(long id, boolean simpleBoolean, byte simpleByte, short simpleShort, int simpleInt,
                       long simpleLong, float simpleFloat, double simpleDouble, String simpleString,
                       byte[] simpleByteArray, String[] simpleStringArray, List<String> simpleStringList,
-                      short simpleShortU, int simpleIntU, long simpleLongU, Map<String, Object> stringObjectMap) {
+                      short simpleShortU, int simpleIntU, long simpleLongU, Map<String, Object> stringObjectMap,
+                      Object flexProperty) {
         this.id = id;
         this.simpleBoolean = simpleBoolean;
         this.simpleByte = simpleByte;
@@ -83,6 +85,7 @@ public TestEntity(long id, boolean simpleBoolean, byte simpleByte, short simpleS
         this.simpleIntU = simpleIntU;
         this.simpleLongU = simpleLongU;
         this.stringObjectMap = stringObjectMap;
+        this.flexProperty = flexProperty;
         if (STRING_VALUE_THROW_IN_CONSTRUCTOR.equals(simpleString)) {
             throw new RuntimeException(EXCEPTION_IN_CONSTRUCTOR_MESSAGE);
         }
@@ -226,6 +229,16 @@ public TestEntity setStringObjectMap(Map<String, Object> stringObjectMap) {
         return this;
     }
 
+    @Nullable
+    public Object getFlexProperty() {
+        return flexProperty;
+    }
+
+    public TestEntity setFlexProperty(@Nullable Object flexProperty) {
+        this.flexProperty = flexProperty;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "TestEntity{" +
@@ -245,6 +258,7 @@ public String toString() {
                 ", simpleIntU=" + simpleIntU +
                 ", simpleLongU=" + simpleLongU +
                 ", stringObjectMap=" + stringObjectMap +
+                ", flexProperty=" + flexProperty +
                 ", noArgsConstructorCalled=" + noArgsConstructorCalled +
                 '}';
     }