Fix warnings/javadocs in sal-distributed-datastore

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / shardstrategy / ShardStrategy.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java
index 9a05c381ea556aeccf10013952aab453282c3dba..0440b7f023c0a264d2ab3e77716303e03a21406f 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java
@@ -11,17 +11,17 @@ package org.opendaylight.controller.cluster.datastore.shardstrategy;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 
 /**
- * The role of ShardStrategy is to figure out which Shards a given piece of data belongs to
+ * The role of ShardStrategy is to figure out which shards a given piece of data belongs to.
  */
 public interface ShardStrategy {
-  /**
-   * Find the name of the shard in which the data pointed to by the specified path belongs in
-   * <p>
-   * Should return the name of the default shard DefaultShardStrategy.DEFAULT_SHARD
-   * if no matching shard was found
-   *
-   * @param path The location of the data in the logical tree
-   * @return
-   */
-  String findShard(YangInstanceIdentifier path);
+    /**
+     * Find the name of the shard in which the data pointed to by the specified path belongs in.
+     * <p/>
+     * Should return the name of the default shard DefaultShardStrategy.DEFAULT_SHARD
+     * if no matching shard was found
+     *
+     * @param path the location of the data in the logical tree
+     * @return the corresponding shard name.
+     */
+    String findShard(YangInstanceIdentifier path);
 }