First cut at describing mechanics. Also make the class final and
annonate nullness.
Change-Id: I94119ab818713110dfab199b0e3f9e9608cfd583
Signed-off-by: Robert Varga <rovarga@cisco.com>
package org.opendaylight.controller.cluster.raft.base.messages;
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;
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;
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() {