Mark parts of Delta/QueryFactory as deprecated

Evolveum · Dec 2, 2019 · 36c4680 · 36c4680
1 parent bcbc5a6
commit 36c4680
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 0 deletions.
diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/PrismContext.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/PrismContext.java
@@ -345,9 +345,24 @@ default ItemPath toPath(ItemPathType path) {
 
     S_FilterEntryOrEmpty queryFor(Class<? extends Containerable> queryClass);
 
+    /**
+     * Access point to the "old" way of creating deltas. It is generally considered deprecated.
+     * DeltaBuilder (accessed via deltaFor method) should be used instead.
+     *
+     * However, because there is some functionality (like creation of empty deltas) that is not covered by the delta
+     * builder, we keep this method not marked as deprecated. Only particular parts of DeltaFactory are marked as deprecated.
+     */
     @NotNull
     DeltaFactory deltaFactory();
 
+    /**
+     * Access point to the "old" way of creating queries, filters and paging instructions.
+     * It is generally considered deprecated. QueryBuilder (accessed via queryFor method) should be used instead.
+     *
+     * However, because there is some functionality (like creation of standalone paging instructions) that is not covered
+     * by the query builder, we keep this method not marked as deprecated. Only particular parts of QueryFactory are marked
+     * as deprecated.
+     */
     @NotNull
     QueryFactory queryFactory();
 

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/delta/DeltaFactory.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/delta/DeltaFactory.java
@@ -20,6 +20,7 @@
  */
 public interface DeltaFactory {
 
+    @Deprecated // please use DeltaBuilder instead
     interface Property {
 
         @SuppressWarnings("unchecked")
@@ -89,6 +90,7 @@ Collection<? extends ItemDelta> createModificationReplacePropertyCollection(QNam
                 PrismObjectDefinition<?> objectDefinition, java.lang.Object... propertyValues);
     }
 
+    @Deprecated // please use DeltaBuilder instead
     interface Reference {
 
         ReferenceDelta create(ItemPath path, PrismReferenceDefinition definition);
@@ -161,6 +163,7 @@ <T extends Objectable> Collection<? extends ItemDelta> createModificationDeleteC
                 PrismObject<?> refTarget);
     }
 
+    @Deprecated // please use DeltaBuilder instead
     interface Container {
         <C extends Containerable> ContainerDelta<C> create(ItemPath path, PrismContainerDefinition<C> definition);
 

diff --git a/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/query/QueryFactory.java b/infra/prism-api/src/main/java/com/evolveum/midpoint/prism/query/QueryFactory.java
@@ -31,67 +31,81 @@ public interface QueryFactory {
 
     ObjectFilter createUndefined();
 
+    @Deprecated // please use QueryBuilder instead
     @NotNull
     <T> EqualFilter<T> createEqual(@NotNull ItemPath path, @Nullable PrismPropertyDefinition<T> definition,
             @Nullable QName matchingRule);
 
     // values
+    @Deprecated // please use QueryBuilder instead
     @NotNull
     <T> EqualFilter<T> createEqual(@NotNull ItemPath path, @Nullable PrismPropertyDefinition<T> definition,
             @Nullable QName matchingRule, @NotNull PrismContext prismContext, Object... values);
 
     // expression-related
+    @Deprecated // please use QueryBuilder instead
     @NotNull
     <T> EqualFilter<T> createEqual(@NotNull ItemPath path, @Nullable PrismPropertyDefinition<T> definition,
             @Nullable QName matchingRule, @NotNull ExpressionWrapper expression);
 
     // right-side-related; right side can be supplied later (therefore it's nullable)
+    @Deprecated // please use QueryBuilder instead
     @NotNull
     <T> EqualFilter<T> createEqual(@NotNull ItemPath path, PrismPropertyDefinition<T> definition,
             QName matchingRule, @NotNull ItemPath rightSidePath, ItemDefinition rightSideDefinition);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     RefFilter createReferenceEqual(ItemPath path, PrismReferenceDefinition definition,
             Collection<PrismReferenceValue> values);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     RefFilter createReferenceEqual(ItemPath path, PrismReferenceDefinition definition, ExpressionWrapper expression);
 
     // empty (can be filled-in later)
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> GreaterFilter<T> createGreater(@NotNull ItemPath path, PrismPropertyDefinition<T> definition, boolean equals);
 
     // value
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> GreaterFilter<T> createGreater(@NotNull ItemPath path, PrismPropertyDefinition<T> definition,
             QName matchingRule, Object value, boolean equals, @NotNull PrismContext prismContext);
 
     // expression-related
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> GreaterFilter<T> createGreater(@NotNull ItemPath path, PrismPropertyDefinition<T> definition, QName matchingRule,
             @NotNull ExpressionWrapper wrapper, boolean equals);
 
     // right-side-related
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> GreaterFilter<T> createGreater(@NotNull ItemPath path, PrismPropertyDefinition<T> definition, QName matchingRule,
             @NotNull ItemPath rightSidePath, ItemDefinition rightSideDefinition, boolean equals);
 
     // empty (can be filled-in later)
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> LessFilter<T> createLess(@NotNull ItemPath path, PrismPropertyDefinition<T> definition, boolean equals);
 
     // value
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> LessFilter<T> createLess(@NotNull ItemPath path, PrismPropertyDefinition<T> definition,
             QName matchingRule, Object value, boolean equals, @NotNull PrismContext prismContext);
 
     // expression-related
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> LessFilter<T> createLess(@NotNull ItemPath path, PrismPropertyDefinition<T> definition, QName matchingRule,
             @NotNull ExpressionWrapper expressionWrapper, boolean equals);
 
     // right-side-related
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     <T> LessFilter<T> createLess(@NotNull ItemPath path, PrismPropertyDefinition<T> definition,
             QName matchingRule, @NotNull ItemPath rightSidePath, ItemDefinition rightSideDefinition, boolean equals);
 
@@ -110,30 +124,39 @@ <T> LessFilter<T> createLess(@NotNull ItemPath path, PrismPropertyDefinition<T>
     @NotNull
     NotFilter createNot(ObjectFilter inner);
 
+    @Deprecated // please use QueryBuilder instead
     <C extends Containerable> ExistsFilter createExists(ItemName path, Class<C> containerType, PrismContext prismContext, ObjectFilter inner);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     InOidFilter createInOid(Collection<String> oids);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     InOidFilter createInOid(String... oids);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     InOidFilter createOwnerHasOidIn(Collection<String> oids);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     InOidFilter createOwnerHasOidIn(String... oids);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     OrgFilter createOrg(PrismReferenceValue baseOrgRef, OrgFilter.Scope scope);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     OrgFilter createOrg(String baseOrgOid, OrgFilter.Scope scope);
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     OrgFilter createRootOrg();
 
     @NotNull
+    @Deprecated // please use QueryBuilder instead
     TypeFilter createType(QName type, ObjectFilter filter);
 
     @NotNull

diff --git a/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/delta/DeltaFactoryImpl.java b/infra/prism-impl/src/main/java/com/evolveum/midpoint/prism/impl/delta/DeltaFactoryImpl.java
@@ -35,16 +35,19 @@ public DeltaFactoryImpl(@NotNull PrismContext prismContext) {
         this.objectDeltaFactory = new ObjectDeltaFactoryImpl(prismContext);
     }
 
+    @Deprecated // please use DeltaBuilder instead
     @Override
     public Property property() {
         return propertyDeltaFactory;
     }
 
+    @Deprecated // please use DeltaBuilder instead
     @Override
     public Reference reference() {
         return referenceDeltaFactory;
     }
 
+    @Deprecated // please use DeltaBuilder instead
     @Override
     public Container container() {
         return containerDeltaFactory;