Clean up (DOM)DataTreeIdentifier methods

[mdsal.git] / binding / mdsal-binding-api / src / main / java / org / opendaylight / mdsal / binding / api / DataTreeIdentifier.java

diff --git a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataTreeIdentifier.java b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataTreeIdentifier.java
index 3f0504c41f36e1a0e6c868983e2949b071ff8dd2..58bfc5ac26ca23b484789cc47c8e8cfeeeaf9456 100644 (file)
--- a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataTreeIdentifier.java
+++ b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/DataTreeIdentifier.java
@@ -11,54 +11,86 @@ import static java.util.Objects.requireNonNull;
 
 import com.google.common.base.MoreObjects;
 import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.common.api.LogicalDatastorePath;
 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
-import org.opendaylight.yangtools.concepts.HierarchicalIdentifier;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
 /**
- * A unique identifier for a particular subtree. It is composed of the logical
- * data store type and the instance identifier of the root node.
+ * A Binding version of {@link LogicalDatastorePath}. Uses {@link InstanceIdentifier} for path addressing.
  */
-public final class DataTreeIdentifier<T extends DataObject> implements HierarchicalIdentifier<DataTreeIdentifier<?>> {
+public final class DataTreeIdentifier<T extends DataObject>
+        implements LogicalDatastorePath<@NonNull DataTreeIdentifier<?>, @NonNull InstanceIdentifier<?>> {
     @java.io.Serial
     private static final long serialVersionUID = 1L;
 
     private final @NonNull InstanceIdentifier<T> rootIdentifier;
     private final @NonNull LogicalDatastoreType datastoreType;
 
-    private DataTreeIdentifier(final @NonNull LogicalDatastoreType datastoreType,
-            final @NonNull InstanceIdentifier<T> rootIdentifier) {
-        this.datastoreType = requireNonNull(datastoreType);
-        this.rootIdentifier = requireNonNull(rootIdentifier);
+    private DataTreeIdentifier(final @NonNull LogicalDatastoreType datastore,
+            final @NonNull InstanceIdentifier<T> path) {
+        datastoreType = requireNonNull(datastore);
+        rootIdentifier = requireNonNull(path);
     }
 
+    /**
+     * Create a new {@link DataTreeIdentifier} with specified datastore and path.
+     *
+     * @param <T> target {@link DataObject} type
+     * @param datastore {@link LogicalDatastoreType} of this identifier
+     * @param path {@link InstanceIdentifier} path of this identifier
+     * @throws NullPointerException if any argument is {@code null}
+     */
+    public static <T extends DataObject> @NonNull DataTreeIdentifier<T> of(
+            final @NonNull LogicalDatastoreType datastore, final @NonNull InstanceIdentifier<T> path) {
+        return new DataTreeIdentifier<>(datastore, path);
+    }
+
+    /**
+     * Create a new {@link DataTreeIdentifier} with specified datastore and path.
+     *
+     * @param <T> target {@link DataObject} type
+     * @param datastore {@link LogicalDatastoreType} of this identifier
+     * @param path {@link InstanceIdentifier} path of this identifier
+     * @throws NullPointerException if any argument is {@code null}
+     * @deprecated Use {@link #of(LogicalDatastoreType, InstanceIdentifier)} instead
+     */
+    @Deprecated(since = "13.0.0", forRemoval = true)
     public static <T extends DataObject> @NonNull DataTreeIdentifier<T> create(
-            final @NonNull LogicalDatastoreType datastoreType, final @NonNull InstanceIdentifier<T> rootIdentifier) {
-        return new DataTreeIdentifier<>(datastoreType, rootIdentifier);
+            final @NonNull LogicalDatastoreType datastore, final @NonNull InstanceIdentifier<T> path) {
+        return of(datastore, path);
+    }
+
+    @Override
+    public LogicalDatastoreType datastore() {
+        return datastoreType;
     }
 
     /**
      * Return the logical data store type.
      *
      * @return Logical data store type. Guaranteed to be non-null.
+     * @deprecated Use {@link #datastore()} instead
      */
+    @Deprecated(since = "13.0.0", forRemoval = true)
     public @NonNull LogicalDatastoreType getDatastoreType() {
-        return datastoreType;
+        return datastore();
+    }
+
+    @Override
+    public InstanceIdentifier<T> path() {
+        return rootIdentifier;
     }
 
     /**
      * Return the {@link InstanceIdentifier} of the root node.
      *
      * @return Instance identifier corresponding to the root node.
+     * @deprecated Use {@link #path()} instead
      */
+    @Deprecated(since = "13.0.0", forRemoval = true)
     public @NonNull InstanceIdentifier<T> getRootIdentifier() {
-        return rootIdentifier;
-    }
-
-    @Override
-    public boolean contains(final DataTreeIdentifier<?> other) {
-        return datastoreType == other.datastoreType && rootIdentifier.contains(other.rootIdentifier);
+        return path();
     }
 
     @Override