Fix warnings/javadocs in sal-distributed-datastore

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

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java
index 5f34578031a6a677089b1b2893f1a2a87e699170..01204ce979b7ebc5262d92d667e31c57c0f3ad97 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerInfoMBean.java
@@ -12,44 +12,48 @@ import java.util.List;
 
 public interface ShardManagerInfoMBean {
     /**
+     * Returns the list of all the local shard names.
      *
      * @return a list of all the local shard names
      */
     List<String> getLocalShards();
 
     /**
+     * Returns the overall sync status for all shards.
      *
      * @return true if all local shards are in sync with their corresponding leaders
      */
     boolean getSyncStatus();
 
     /**
-     * Get the name of of the current member
+     * Returns the name of the local member.
      *
-     * @return
+     * @return the local member name
      */
     String getMemberName();
 
     /**
-     * Switch the Raft Behavior of all the local shards to the newBehavior
+     * Switches the raft behavior of all the local shards to the newBehavior.
      *
      * @param newBehavior should be either Leader/Follower only
-     * @param term when switching to the Leader specifies for which term the Shard would be the Leader. Any modifications
-     *             made to state will be written with this term. This term will then be used by the Raft replication
-     *             implementation to decide which modifications should stay and which ones should be removed. Ideally
-     *             the term provided when switching to a new Leader should always be higher than the previous term.
+     * @param term when switching to the Leader specifies for which term the Shard would be the Leader. Any
+     *             modifications made to state will be written with this term. This term will then be used by the Raft
+     *             replication implementation to decide which modifications should stay and which ones should be
+     *             removed. Ideally the term provided when switching to a new Leader should always be higher than the
+     *             previous term.
      */
     void switchAllLocalShardsState(String newBehavior, long term);
 
     /**
-     * Switch the Raft Behavior of the shard specified by shardName to the newBehavior
+     * Switches the raft behavior of the shard specified by shardName to the newBehavior.
      *
      * @param shardName a shard that is local to this shard manager
      * @param newBehavior should be either Leader/Follower only
-     * @param term when switching to the Leader specifies for which term the Shard would be the Leader. Any modifications
-     *             made to state will be written with this term. This term will then be used by the Raft replication
-     *             implementation to decide which modifications should stay and which ones should be removed. Ideally
-     *             the term provided when switching to a new Leader should always be higher than the previous term.
+     * @param term when switching to the Leader specifies for which term the Shard would be the Leader. Any
+     *             modifications made to state will be written with this term. This term will then be used by the Raft
+     *             replication implementation to decide which modifications should stay and which ones should be
+     *             removed. Ideally the term provided when switching to a new Leader should always be higher than the
+     *             previous term.
      */
     void switchShardState(String shardName, String newBehavior, long term);
 }