3f0cf43ac942238f814190af05a45bc3241712f1
[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 com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.base.Preconditions;
13 import java.io.Serializable;
14 import java.util.Optional;
15 import javax.annotation.Nonnull;
16 import javax.annotation.Nullable;
17
18 /**
19  * Abstract base class for a server configuration change reply.
20  *
21  * @author Thomas Pantelis
22  */
23 public abstract class AbstractServerChangeReply implements Serializable {
24     private static final long serialVersionUID = 1L;
25
26     private final String leaderHint;
27     private final ServerChangeStatus status;
28
29     AbstractServerChangeReply(final @Nonnull ServerChangeStatus status, final @Nullable String leaderHint) {
30         this.status = Preconditions.checkNotNull(status);
31         this.leaderHint = leaderHint;
32     }
33
34     @VisibleForTesting
35     @Nonnull public final Optional<String> getLeaderHint() {
36         return Optional.ofNullable(leaderHint);
37     }
38
39     @Nonnull public final ServerChangeStatus getStatus() {
40         return status;
41     }
42
43     @Override
44     public final String toString() {
45         return MoreObjects.toStringHelper(getClass()).omitNullValues()
46             .add("status", status).add("leaderHint", leaderHint).toString();
47     }
48 }