From d89e839b36a664c32a40706afaa1a10ac5b64b3b Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sun, 14 Feb 2016 01:31:46 +0100 Subject: [PATCH] Add SendInstallSnapshot javadoc First cut at describing mechanics. Also make the class final and annonate nullness. Change-Id: I94119ab818713110dfab199b0e3f9e9608cfd583 Signed-off-by: Robert Varga --- .../raft/base/messages/SendInstallSnapshot.java | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) 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 21c65e6037..94e31846ee 100644 --- 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 @@ -8,16 +8,22 @@ package org.opendaylight.controller.cluster.raft.base.messages; +import com.google.common.base.Preconditions; +import javax.annotation.Nonnull; import org.opendaylight.controller.cluster.raft.Snapshot; -public class SendInstallSnapshot { +/** + * Internal message sent from the SnapshotManager to its associated leader. The leader is expected to apply the + * {@link Snapshot} to its state. + */ +public final class SendInstallSnapshot { private final Snapshot snapshot; - public SendInstallSnapshot(Snapshot snapshot) { - this.snapshot = snapshot; + public SendInstallSnapshot(@Nonnull Snapshot snapshot) { + this.snapshot = Preconditions.checkNotNull(snapshot); } - public Snapshot getSnapshot() { + @Nonnull public Snapshot getSnapshot() { return snapshot; } } -- 2.36.6