Sho SHIMIZU
Committed by Gerrit Code Review

Insert a blank line after the description in Javadoc

Change-Id: Id83ef1bf434e3f99fd2aedd91f10da0d7f98e4cb
...@@ -62,6 +62,7 @@ public class Leadership { ...@@ -62,6 +62,7 @@ public class Leadership {
62 62
63 /** 63 /**
64 * The topic for which this leadership applies. 64 * The topic for which this leadership applies.
65 + *
65 * @return leadership topic. 66 * @return leadership topic.
66 */ 67 */
67 public String topic() { 68 public String topic() {
...@@ -70,6 +71,7 @@ public class Leadership { ...@@ -70,6 +71,7 @@ public class Leadership {
70 71
71 /** 72 /**
72 * The nodeId of leader for this topic. 73 * The nodeId of leader for this topic.
74 + *
73 * @return leader node. 75 * @return leader node.
74 */ 76 */
75 public NodeId leader() { 77 public NodeId leader() {
...@@ -108,6 +110,7 @@ public class Leadership { ...@@ -108,6 +110,7 @@ public class Leadership {
108 * clock skew, relying on this value for determining event ordering 110 * clock skew, relying on this value for determining event ordering
109 * is discouraged. Epoch is more appropriate for determining 111 * is discouraged. Epoch is more appropriate for determining
110 * event ordering. 112 * event ordering.
113 + *
111 * @return elected time. 114 * @return elected time.
112 */ 115 */
113 public long electedTime() { 116 public long electedTime() {
......
...@@ -30,6 +30,7 @@ public interface LeadershipService { ...@@ -30,6 +30,7 @@ public interface LeadershipService {
30 30
31 /** 31 /**
32 * Returns the current leader for the topic. 32 * Returns the current leader for the topic.
33 + *
33 * @param path topic 34 * @param path topic
34 * @return nodeId of the leader, null if so such topic exists. 35 * @return nodeId of the leader, null if so such topic exists.
35 */ 36 */
...@@ -37,6 +38,7 @@ public interface LeadershipService { ...@@ -37,6 +38,7 @@ public interface LeadershipService {
37 38
38 /** 39 /**
39 * Returns the current leadership info for the topic. 40 * Returns the current leadership info for the topic.
41 + *
40 * @param path topic 42 * @param path topic
41 * @return leadership info or null if so such topic exists. 43 * @return leadership info or null if so such topic exists.
42 */ 44 */
...@@ -44,6 +46,7 @@ public interface LeadershipService { ...@@ -44,6 +46,7 @@ public interface LeadershipService {
44 46
45 /** 47 /**
46 * Returns the set of topics owned by the specified node. 48 * Returns the set of topics owned by the specified node.
49 + *
47 * @param nodeId node Id. 50 * @param nodeId node Id.
48 * @return set of topics for which this node is the current leader. 51 * @return set of topics for which this node is the current leader.
49 */ 52 */
...@@ -51,30 +54,35 @@ public interface LeadershipService { ...@@ -51,30 +54,35 @@ public interface LeadershipService {
51 54
52 /** 55 /**
53 * Joins the leadership contest. 56 * Joins the leadership contest.
57 + *
54 * @param path topic for which this controller node wishes to be a leader. 58 * @param path topic for which this controller node wishes to be a leader.
55 */ 59 */
56 void runForLeadership(String path); 60 void runForLeadership(String path);
57 61
58 /** 62 /**
59 * Withdraws from a leadership contest. 63 * Withdraws from a leadership contest.
64 + *
60 * @param path topic for which this controller node no longer wishes to be a leader. 65 * @param path topic for which this controller node no longer wishes to be a leader.
61 */ 66 */
62 void withdraw(String path); 67 void withdraw(String path);
63 68
64 /** 69 /**
65 * Returns the current leader board. 70 * Returns the current leader board.
71 + *
66 * @return mapping from topic to leadership info. 72 * @return mapping from topic to leadership info.
67 */ 73 */
68 Map<String, Leadership> getLeaderBoard(); 74 Map<String, Leadership> getLeaderBoard();
69 75
70 /** 76 /**
71 * Returns the candidates for all known topics. 77 * Returns the candidates for all known topics.
78 + *
72 * @return A map of topics to lists of NodeIds. 79 * @return A map of topics to lists of NodeIds.
73 */ 80 */
74 Map<String, List<NodeId>> getCandidates(); 81 Map<String, List<NodeId>> getCandidates();
75 82
76 /** 83 /**
77 * Returns the candidates for a given topic. 84 * Returns the candidates for a given topic.
85 + *
78 * @param path topic 86 * @param path topic
79 * @return A lists of NodeIds, which may be empty. 87 * @return A lists of NodeIds, which may be empty.
80 */ 88 */
...@@ -82,12 +90,14 @@ public interface LeadershipService { ...@@ -82,12 +90,14 @@ public interface LeadershipService {
82 90
83 /** 91 /**
84 * Registers a event listener to be notified of leadership events. 92 * Registers a event listener to be notified of leadership events.
93 + *
85 * @param listener listener that will asynchronously notified of leadership events. 94 * @param listener listener that will asynchronously notified of leadership events.
86 */ 95 */
87 void addListener(LeadershipEventListener listener); 96 void addListener(LeadershipEventListener listener);
88 97
89 /** 98 /**
90 * Unregisters a event listener for leadership events. 99 * Unregisters a event listener for leadership events.
100 + *
91 * @param listener listener to be removed. 101 * @param listener listener to be removed.
92 */ 102 */
93 void removeListener(LeadershipEventListener listener); 103 void removeListener(LeadershipEventListener listener);
......