Refactor Register*ListenerReply classes

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

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/AddPrefixShardReplica.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/AddPrefixShardReplica.java
index 2ac883be8d40898eac0dbcebf75a1b7a27742bc3..05e1271dd0439618bd7da626d39c5094db66ed93 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/AddPrefixShardReplica.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/AddPrefixShardReplica.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2017 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -9,28 +9,34 @@
 package org.opendaylight.controller.cluster.datastore.messages;
 
 import com.google.common.base.Preconditions;
+import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 
 /**
  * A message sent to the ShardManager to dynamically add a new local shard
- * that is a replica for an existing shard that is already available in the
- * cluster.
+ *  that is a replica for an existing prefix shard that is already available
+ *  in the cluster.
  */
-
 public class AddPrefixShardReplica {
 
     private final YangInstanceIdentifier prefix;
 
-    public AddPrefixShardReplica(final YangInstanceIdentifier prefix) {
-        this.prefix = Preconditions.checkNotNull(prefix);
+    /**
+     * Constructor.
+     *
+     * @param prefix prefix of the shard that is to be locally replicated.
+     */
+
+    public AddPrefixShardReplica(@Nonnull final YangInstanceIdentifier prefix) {
+        this.prefix = Preconditions.checkNotNull(prefix, "prefix should not be null");
     }
 
-    public YangInstanceIdentifier getPrefix() {
-        return prefix;
+    public YangInstanceIdentifier getShardPrefix() {
+        return this.prefix;
     }
 
     @Override
     public String toString() {
-        return "AddPrefixShardReplica[ShardName=" + prefix + "]";
+        return "AddPrefixShardReplica[prefix=" + prefix + "]";
     }
 }