Deprecate ClassToInstance-taking methods

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

diff --git a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ReadOperations.java b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ReadOperations.java
index ff93bac36bf1d90a33298e1816e7b91cfd381083..99c41b40ffbd77ac51be2137d17497252c314fd6 100644 (file)
--- a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ReadOperations.java
+++ b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ReadOperations.java
@@ -9,8 +9,10 @@ package org.opendaylight.mdsal.binding.api;
 
 import com.google.common.util.concurrent.FluentFuture;
 import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
 import org.opendaylight.mdsal.common.api.ReadFailedException;
+import org.opendaylight.mdsal.common.api.TransactionDatastoreMismatchException;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
@@ -28,8 +30,8 @@ public interface ReadOperations {
      *
      * @param store Logical data store from which read should occur.
      * @param path Path which uniquely identifies subtree which client want to read
-     * @return a FluentFuture containing the result of the read. The Future blocks until the commit operation is
-     *         complete. Once complete:
+     * @return a FluentFuture containing the result of the read. The Future blocks until the operation is complete. Once
+     *         complete:
      *         <ul>
      *         <li>If the data at the supplied path exists, the Future returns an Optional object containing the data.
      *         </li>
@@ -37,6 +39,35 @@ public interface ReadOperations {
      *         <li>If the read of the data fails, the Future will fail with a {@link ReadFailedException} or
      *         an exception derived from ReadFailedException.</li>
      *         </ul>
+     * @throws IllegalArgumentException if the path is {@link InstanceIdentifier#isWildcarded()}
+     * @throws NullPointerException if any of the arguments is {@code null}
+     * @throws TransactionDatastoreMismatchException if this transaction is already bound to a different data store
      */
-    <T extends DataObject> FluentFuture<Optional<T>> read(LogicalDatastoreType store, InstanceIdentifier<T> path);
+    <T extends DataObject> @NonNull FluentFuture<Optional<T>> read(@NonNull LogicalDatastoreType store,
+            @NonNull InstanceIdentifier<T> path);
+
+    /**
+     * Determines if data data exists in the provided logical data store located at the provided path.
+     *
+     * <p>
+     * Default implementation just delegates to {@link #read(LogicalDatastoreType, InstanceIdentifier)}. Implementations
+     * are recommended to override with a more efficient implementation.
+     *
+     * @param store Logical data store from which read should occur.
+     * @param path Path which uniquely identifies subtree which client want to read
+     * @return a FluentFuture containing the result of the check. The Future blocks until the operation is complete.
+     *         Once complete:
+     *         <ul>
+     *         <li>If the data at the supplied path exists, the Future returns {@link Boolean#TRUE}.
+     *         </li>
+     *         <li>If the data at the supplied path does not exist, the Future returns {@link Boolean#FALSE}.</li>
+     *         <li>If the check fails, the Future will fail with a {@link ReadFailedException} or an exception derived
+     *             from ReadFailedException.</li>
+     *         </ul>
+     * @throws IllegalArgumentException if the path is {@link InstanceIdentifier#isWildcarded()} and the implementation
+     *                                  does not support evaluating wildcards.
+     * @throws NullPointerException if any of the arguments is {@code null}
+     * @throws TransactionDatastoreMismatchException if this transaction is already bound to a different data store
+     */
+    @NonNull FluentFuture<Boolean> exists(@NonNull LogicalDatastoreType store, @NonNull InstanceIdentifier<?> path);
 }