Reduce JSR305 proliferation
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / base / messages / CaptureSnapshotReply.java
index 1e573014a9ed6596ae6af84df0f724a9e730c34c..552c7df22d8e10401384c993deb2988714d90f81 100644 (file)
@@ -7,22 +7,29 @@
  */
 package org.opendaylight.controller.cluster.raft.base.messages;
 
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import static java.util.Objects.requireNonNull;
 
-public class CaptureSnapshotReply {
-    private final byte [] snapshot;
+import akka.dispatch.ControlMessage;
+import java.io.OutputStream;
+import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
 
-    @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "Stores a reference to an externally mutable byte[] "
-            + "object but this is OK since this class is merely a DTO and does not process byte[] internally. "
-            + "Also it would be inefficient to create a copy as the byte[] could be large.")
-    public CaptureSnapshotReply(byte [] snapshot) {
-        this.snapshot = snapshot;
+public class CaptureSnapshotReply implements ControlMessage {
+    private final Snapshot.State snapshotState;
+    private final Optional<OutputStream> installSnapshotStream;
+
+    public CaptureSnapshotReply(final Snapshot.@NonNull State snapshotState,
+            final @NonNull Optional<OutputStream> installSnapshotStream) {
+        this.snapshotState = requireNonNull(snapshotState);
+        this.installSnapshotStream = requireNonNull(installSnapshotStream);
+    }
+
+    public Snapshot.@NonNull State getSnapshotState() {
+        return snapshotState;
     }
 
-    @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Exposes a mutable object stored in a field but "
-            + "this is OK since this class is merely a DTO and does not process the byte[] internally. "
-            + "Also it would be inefficient to create a return copy as the byte[] could be large.")
-    public byte [] getSnapshot() {
-        return snapshot;
+    public @NonNull Optional<OutputStream> getInstallSnapshotStream() {
+        return installSnapshotStream;
     }
 }