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 / messages / InstallSnapshotReply.java
1 /*
2  * Copyright (c) 2014 Cisco 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
9 package org.opendaylight.controller.cluster.raft.messages;
10
11 import java.io.Externalizable;
12 import java.io.IOException;
13 import java.io.ObjectInput;
14 import java.io.ObjectOutput;
15
16 public class InstallSnapshotReply extends AbstractRaftRPC {
17     private static final long serialVersionUID = 642227896390779503L;
18
19     // The followerId - this will be used to figure out which follower is
20     // responding
21     private final String followerId;
22     private final int chunkIndex;
23     private final boolean success;
24
25     public InstallSnapshotReply(long term, String followerId, int chunkIndex, boolean success) {
26         super(term);
27         this.followerId = followerId;
28         this.chunkIndex = chunkIndex;
29         this.success = success;
30     }
31
32     public String getFollowerId() {
33         return followerId;
34     }
35
36     public int getChunkIndex() {
37         return chunkIndex;
38     }
39
40     public boolean isSuccess() {
41         return success;
42     }
43
44     @Override
45     public String toString() {
46         StringBuilder builder = new StringBuilder();
47         builder.append("InstallSnapshotReply [term=").append(getTerm()).append(", followerId=").append(followerId)
48                 .append(", chunkIndex=").append(chunkIndex).append(", success=").append(success).append("]");
49         return builder.toString();
50     }
51
52     private Object writeReplace() {
53         return new Proxy(this);
54     }
55
56     private static class Proxy implements Externalizable {
57         private static final long serialVersionUID = 1L;
58
59         private InstallSnapshotReply installSnapshotReply;
60
61         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
62         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
63         @SuppressWarnings("checkstyle:RedundantModifier")
64         public Proxy() {
65         }
66
67         Proxy(InstallSnapshotReply installSnapshotReply) {
68             this.installSnapshotReply = installSnapshotReply;
69         }
70
71         @Override
72         public void writeExternal(ObjectOutput out) throws IOException {
73             out.writeLong(installSnapshotReply.getTerm());
74             out.writeObject(installSnapshotReply.followerId);
75             out.writeInt(installSnapshotReply.chunkIndex);
76             out.writeBoolean(installSnapshotReply.success);
77         }
78
79         @Override
80         public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
81             long term = in.readLong();
82             String followerId = (String) in.readObject();
83             int chunkIndex = in.readInt();
84             boolean success = in.readBoolean();
85
86             installSnapshotReply = new InstallSnapshotReply(term, followerId, chunkIndex, success);
87         }
88
89         private Object readResolve() {
90             return installSnapshotReply;
91         }
92     }
93 }