Unique: add onConflict which accepts a ConflictStrategy.

greenrobot-team · greenrobot-team · commit 00ae9a4bfea9 · 2021-04-26T12:59:44.000+02:00
diff --git a/objectbox-java-api/src/main/java/io/objectbox/annotation/ConflictStrategy.java b/objectbox-java-api/src/main/java/io/objectbox/annotation/ConflictStrategy.java
@@ -0,0 +1,30 @@
+package io.objectbox.annotation;
+
+/**
+ * Used with {@link Unique} to specify the conflict resolution strategy.
+ */
+public enum ConflictStrategy {
+
+    /**
+     * Default. Throws UniqueViolationException if any property violates a {@link Unique} constraint.
+     */
+    FAIL,
+    /**
+     * Ignore the offending object (the existing object is not changed). If there are multiple unique properties in an
+     * entity, this strategy is evaluated first: if the property conflicts, no other properties will be checked for
+     * conflicts.
+     */
+    IGNORE,
+    /**
+     * The offending object replaces the existing object (deletes it). If there are multiple properties using this
+     * strategy, a single put can potentially replace (delete) multiple existing objects.
+     */
+    REPLACE,
+    /**
+     * The offending object overwrites the existing object while keeping its ID. All relations pointing to the existing
+     * entity are preserved. This is useful for a "secondary" ID, such as a string "ID". Within an entity, this strategy
+     * may be used once only (update target would be ambiguous otherwise).
+     */
+    UPDATE
+
+}
diff --git a/objectbox-java-api/src/main/java/io/objectbox/annotation/Unique.java b/objectbox-java-api/src/main/java/io/objectbox/annotation/Unique.java
@@ -25,11 +25,13 @@
  * Enforces that the value of a property is unique among all objects in a box before an object can be put.
  * <p>
  * Trying to put an object with offending values will result in a UniqueViolationException.
+ * Specify a {@link ConflictStrategy} to change this default behavior.
  * <p>
  * Unique properties are based on an {@link Index @Index}, so the same restrictions apply.
  * It is supported to explicitly add the {@link Index @Index} annotation to configure the index.
  */
 @Retention(RetentionPolicy.CLASS)
 @Target(ElementType.FIELD)
 public @interface Unique {
+    ConflictStrategy onConflict() default ConflictStrategy.FAIL;
 }
