Fix warnings and clean up javadocs in sal-akka-raft

[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / base / messages / SendInstallSnapshot.java

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/base/messages/SendInstallSnapshot.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/base/messages/SendInstallSnapshot.java
index 94e31846eebf1d947d483585ce19ec2b3a3f5ae7..de33b8c95b1ad0679d6a2af3c37e880dca099efa 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/base/messages/SendInstallSnapshot.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/base/messages/SendInstallSnapshot.java
@@ -13,8 +13,8 @@ import javax.annotation.Nonnull;
 import org.opendaylight.controller.cluster.raft.Snapshot;
 
 /**
- * Internal message sent from the SnapshotManager to its associated leader. The leader is expected to apply the
- * {@link Snapshot} to its state.
+ * Internal message sent from the SnapshotManager to its associated leader when a snapshot capture is complete to
+ * prompt the leader to install the snapshot on its followers as needed.
  */
 public final class SendInstallSnapshot {
     private final Snapshot snapshot;
@@ -23,7 +23,8 @@ public final class SendInstallSnapshot {
         this.snapshot = Preconditions.checkNotNull(snapshot);
     }
 
-    @Nonnull public Snapshot getSnapshot() {
+    @Nonnull
+    public Snapshot getSnapshot() {
         return snapshot;
     }
 }