Reduce JSR305 proliferation

[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / client / messages / FindLeaderReply.java

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java
index 8b2e45aa0601b3d62624f4bd3831042af36e6246..b4b34437e844e7d160fbc7e4e7c77388172d334c 100644 (file)
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java
@@ -5,20 +5,31 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.controller.cluster.raft.client.messages;
 
+import com.google.common.annotations.VisibleForTesting;
 import java.io.Serializable;
+import java.util.Optional;
+import org.eclipse.jdt.annotation.Nullable;
 
-public class FindLeaderReply implements Serializable {
+/**
+ * Reply to {@link FindLeader} message, containing the address of the leader actor, as known to the raft actor which
+ * sent the message. If the responding actor does not have knowledge of the leader, {@link #getLeaderActor()} will
+ * return {@link Optional#empty()}.
+ *
+ * <p>
+ * This message is intended for testing purposes only.
+ */
+@VisibleForTesting
+public final class FindLeaderReply implements Serializable {
     private static final long serialVersionUID = 1L;
     private final String leaderActor;
 
-    public FindLeaderReply(String leaderActor) {
+    public FindLeaderReply(final @Nullable String leaderActor) {
         this.leaderActor = leaderActor;
     }
 
-    public String getLeaderActor() {
-        return leaderActor;
+    public Optional<String> getLeaderActor() {
+        return Optional.ofNullable(leaderActor);
     }
 }