Reduce JSR305 proliferation
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / messages / AbstractServerChangeReply.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.messages;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.annotations.VisibleForTesting;
13 import com.google.common.base.MoreObjects;
14 import java.io.Serializable;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.eclipse.jdt.annotation.Nullable;
18
19 /**
20  * Abstract base class for a server configuration change reply.
21  *
22  * @author Thomas Pantelis
23  */
24 public abstract class AbstractServerChangeReply implements Serializable {
25     private static final long serialVersionUID = 1L;
26
27     private final String leaderHint;
28     private final ServerChangeStatus status;
29
30     AbstractServerChangeReply(final @NonNull ServerChangeStatus status, final @Nullable String leaderHint) {
31         this.status = requireNonNull(status);
32         this.leaderHint = leaderHint;
33     }
34
35     @VisibleForTesting
36     public final @NonNull Optional<String> getLeaderHint() {
37         return Optional.ofNullable(leaderHint);
38     }
39
40     public final @NonNull ServerChangeStatus getStatus() {
41         return status;
42     }
43
44     @Override
45     public final String toString() {
46         return MoreObjects.toStringHelper(getClass()).omitNullValues()
47             .add("status", status).add("leaderHint", leaderHint).toString();
48     }
49 }