More external types: add new enums #260

greenrobot-team · greenrobot-team · commit c6bd0c2ba0fc · 2025-03-11T14:06:21.000+01:00
diff --git a/objectbox-java-api/src/main/java/io/objectbox/annotation/ExternalPropertyType.java b/objectbox-java-api/src/main/java/io/objectbox/annotation/ExternalPropertyType.java
@@ -31,6 +31,12 @@ public enum ExternalPropertyType {
      */
     INT_128,
     /**
+     * A UUID (Universally Unique Identifier) as defined by RFC 9562.
+     * <p>
+     * ObjectBox uses the UUIDv7 scheme (timestamp + random) to create new UUIDs. UUIDv7 is a good choice for database
+     * keys as it's mostly sequential and encodes a timestamp. However, if keys are used externally, consider
+     * {@link #UUID_V4} for better privacy by not exposing any time information.
+     * <p>
      * Representing type: ByteVector
      * <p>
      * Encoding: 1:1 binary representation (16 bytes)
@@ -44,6 +50,32 @@ public enum ExternalPropertyType {
      * Encoding: 1:1 binary representation (16 bytes)
      */
     DECIMAL_128,
+    /**
+     * UUID represented as a string of 36 characters, e.g. "019571b4-80e3-7516-a5c1-5f1053d23fff".
+     * <p>
+     * For efficient storage, consider the {@link #UUID} type instead, which occupies only 16 bytes (20 bytes less).
+     * This type may still be a convenient alternative as the string type is widely supported and more human-readable.
+     * In accordance to standards, new UUIDs generated by ObjectBox use lowercase hexadecimal digits.
+     * <p>
+     * Representing type: String
+     */
+    UUID_STRING,
+    /**
+     * A UUID (Universally Unique Identifier) as defined by RFC 9562.
+     * <p>
+     * ObjectBox uses the UUIDv4 scheme (completely random) to create new UUIDs.
+     * <p>
+     * Representing type: ByteVector
+     * <p>
+     * Encoding: 1:1 binary representation (16 bytes)
+     */
+    UUID_V4,
+    /**
+     * Like {@link #UUID_STRING}, but using the UUIDv4 scheme (completely random) to create new UUID.
+     * <p>
+     * Representing type: String
+     */
+    UUID_V4_STRING,
     /**
      * A key/value map; e.g. corresponds to a JSON object or a MongoDB document (although not keeping the key order).
      * Unlike the Flex type, this must contain a map value (e.g. not a vector or a scalar).
