opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/GetSnapshotReply.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.raft.client.messages;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  15
  16 /**
  17  * Reply to GetSnapshot that returns a serialized Snapshot instance.
  18  *
  19  * @author Thomas Pantelis
  20  */
  21 public class GetSnapshotReply {
  22     private final String id;
  23     private final Snapshot snapshot;
  24
  25     public GetSnapshotReply(@NonNull String id, @NonNull Snapshot snapshot) {
  26         this.id = requireNonNull(id);
  27         this.snapshot = requireNonNull(snapshot);
  28     }
  29
  30     public @NonNull String getId() {
  31         return id;
  32     }
  33
  34     @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "Exposes a mutable object stored in a field but "
  35             + "this is OK since this class is merely a DTO and does not process the byte[] internally. "
  36             + "Also it would be inefficient to create a return copy as the byte[] could be large.")
  37     public @NonNull Snapshot getSnapshot() {
  38         return snapshot;
  39     }
  40
  41     @Override
  42     public String toString() {
  43         return "GetSnapshotReply [id=" + id + ", snapshot=" + snapshot + "]";
  44     }
  45 }