Leadership (ONOS Java API (2.5.6))

java.lang.Object
- org.onosproject.cluster.Leadership

```
public class Leadership
extends Object
```
State of leadership for topic.
Provided by this construct is the current leader and the list of nodeIds currently registered as candidates for election for the topic. Keep in mind that only registered candidates can become leaders.

Constructor Summary

Constructors
Constructor Description

Leadership(String topic, Leader leader, List<NodeId> candidates)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<NodeId>`	`candidates()`	Returns an preference-ordered list of nodes that are in the leadership race for this topic.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`Leader`	`leader()`	Returns the leader for this topic.
`NodeId`	`leaderNodeId()`	Returns the `nodeId` of the leader.
`String`	`topic()`	Returns the leadership topic.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Leadership
```
public Leadership(String topic,
                  Leader leader,
                  List<NodeId> candidates)
```
- Method Detail
  - topic
```
public String topic()
```
    Returns the leadership topic.
    
    Returns:
    
    leadership topic.
  - leaderNodeId
```
public NodeId leaderNodeId()
```
    Returns the nodeId of the leader.
    
    Returns:
    
    leader node identifier; will be null if there is no leader
  - leader
```
public Leader leader()
```
    Returns the leader for this topic.
    
    Returns:
    
    leader; will be null if there is no leader for topic
  - candidates
```
public List<NodeId> candidates()
```
    Returns an preference-ordered list of nodes that are in the leadership race for this topic.
    
    Returns:
    
    a list of NodeIds in priority-order, or an empty list.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object