checkStyleViolationSeverity=error implemented for mdsal-binding-api module
[mdsal.git] / binding / mdsal-binding-api / src / main / java / org / opendaylight / mdsal / binding / api / ReadTransaction.java
index c9d9c069b40cbbee981bd18994dd0a03388b71c0..9a4c682b31d501976e226c32404b60622310b9e6 100644 (file)
@@ -7,24 +7,27 @@
  */
 package org.opendaylight.mdsal.binding.api;
 
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.CheckedFuture;
 import org.opendaylight.mdsal.common.api.AsyncReadTransaction;
 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
 import org.opendaylight.mdsal.common.api.ReadFailedException;
-
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import com.google.common.base.Optional;
-import com.google.common.util.concurrent.CheckedFuture;
+
 
 /**
- * A transaction that provides read access to a logical data store.
+ * A transaction that provides a stateful read-only view of the data tree.
+ *
  * <p>
- * For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}.
+ * For more information on usage and examples, please see the documentation in
+ *  {@link org.opendaylight.mdsal.common.api.AsyncReadTransaction}.
  */
 public interface ReadTransaction extends AsyncReadTransaction<InstanceIdentifier<?>, DataObject> {
 
     /**
      * Reads data from the provided logical data store located at the provided path.
+     *
      *<p>
      * If the target is a subtree, then the whole subtree is read (and will be
      * accessible from the returned data object).