Deprecate old MD-SAL APIs for removal

[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / data / DataReader.java

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataReader.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataReader.java
index ff1703f18152a280e94ed270562dbd0ebb441c05..9ede6381b5207b66db8238892898fca359b480a3 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataReader.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataReader.java
@@ -7,16 +7,27 @@
  */
 package org.opendaylight.controller.md.sal.common.api.data;
 
-// FIXME: After 0.6 Release of YANGTools refactor to use Path marker interface for arguments.
-// import org.opendaylight.yangtools.concepts.Path;
+import org.opendaylight.yangtools.concepts.Path;
 
-public interface DataReader<P/* extends Path<P> */,D> {
+/**
+ * Reader for reading YANG subtrees based on their path.
+ *
+ * <p>
+ * Reader is requested to return object at specified path and all it's subnodes
+ * known to the reader or null if node is not found in this reader.
+ *
+ * @param <P> Path Type
+ * @param <D> Data Type
+ * @deprecated Replaced by org.opendaylight.controller.sal.core.spi.data.DOMStore contract.
+ */
+@Deprecated(forRemoval = true)
+public interface DataReader<P extends Path<P>, D> {
 
     /**
-     * Reads data from Operational data store located at provided path
-     * 
+     * Reads data from Operational data store located at provided path.
+     *
      * @param path Path to data
-     * @return
+     * @return the data
      */
     D readOperationalData(P path);