Configuration (jraft-core 1.3.8 1.3.8 API)

java.lang.Object
- com.alipay.sofa.jraft.conf.Configuration

所有已实现的接口:

Copiable<Configuration>, Iterable<PeerId>
```
public class Configuration
extends Object
implements Iterable<PeerId>, Copiable<Configuration>
```
A configuration with a set of peers.

作者:

boyan (boyan@alibaba-inc.com) 2018-Mar-15 11:00:26 AM

构造器概要

构造器
构造器和说明
`Configuration()`
`Configuration(Configuration conf)` Construct a configuration from another conf.
`Configuration(Iterable<PeerId> conf)` Construct a configuration instance with peers.
`Configuration(Iterable<PeerId> conf, Iterable<PeerId> learners)` Construct a Configuration instance with peers and learners.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`addLearner(PeerId learner)` Add a learner peer.
`int`	`addLearners(Iterable<PeerId> learners)` Add learners in batch, returns the added count.
`boolean`	`addPeer(PeerId peer)`
`void`	`appendPeers(Collection<PeerId> set)`
`boolean`	`contains(PeerId peer)`
`Configuration`	`copy()` Copy current object(deep-clone).
`void`	`diff(Configuration rhs, Configuration included, Configuration excluded)` Get the difference between \|this\| and \|rhs\| \|included\| would be assigned to \|this\| - \|rhs\| \|excluded\| would be assigned to \|rhs\| - \|*this\|
`boolean`	`equals(Object obj)`
`LinkedHashSet<PeerId>`	`getLearners()` Retrieve the learners set.
`List<PeerId>`	`getPeers()`
`Set<PeerId>`	`getPeerSet()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isValid()` Returns true when the configuration is valid.
`Iterator<PeerId>`	`iterator()`
`List<PeerId>`	`listLearners()` Retrieve the learners set copy.
`List<PeerId>`	`listPeers()`
`boolean`	`parse(String conf)`
`boolean`	`removeLearner(PeerId learner)` Remove a learner peer.
`boolean`	`removePeer(PeerId peer)`
`void`	`reset()`
`void`	`setLearners(LinkedHashSet<PeerId> learners)`
`void`	`setPeers(List<PeerId> peers)`
`int`	`size()` Returns the peers total number.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 构造器详细资料
  - Configuration
```
public Configuration()
```
  - Configuration
```
public Configuration(Iterable<PeerId> conf)
```
    Construct a configuration instance with peers.
    
    参数:
    
    conf - configuration
  - Configuration
```
public Configuration(Configuration conf)
```
    Construct a configuration from another conf.
    
    参数:
    
    conf - configuration
  - Configuration
```
public Configuration(Iterable<PeerId> conf,
                     Iterable<PeerId> learners)
```
    Construct a Configuration instance with peers and learners.
    
    参数:
    
    conf - peers configuration
    
    learners - learners
    
    从以下版本开始:
    
    1.3.0
- 方法详细资料
  - setLearners
```
public void setLearners(LinkedHashSet<PeerId> learners)
```
  - addLearner
```
public boolean addLearner(PeerId learner)
```
    Add a learner peer.
    
    参数:
    
    learner - learner to add
    
    返回:
    
    true when add successfully.
  - addLearners
```
public int addLearners(Iterable<PeerId> learners)
```
    Add learners in batch, returns the added count.
    
    参数:
    
    learners - learners to add
    
    返回:
    
    the total added count
  - removeLearner
```
public boolean removeLearner(PeerId learner)
```
    Remove a learner peer.
    
    参数:
    
    learner - learner to remove
    
    返回:
    
    true when remove successfully.
  - getLearners
```
public LinkedHashSet<PeerId> getLearners()
```
    Retrieve the learners set.
    
    返回:
    
    learners
  - listLearners
```
public List<PeerId> listLearners()
```
    Retrieve the learners set copy.
    
    返回:
    
    learners
  - copy
```
public Configuration copy()
```
    从接口复制的说明: Copiable
    
    Copy current object(deep-clone).
    
    指定者:
    
    copy 在接口中 Copiable<Configuration>
  - isValid
```
public boolean isValid()
```
    Returns true when the configuration is valid.
    
    返回:
    
    true if the configuration is valid.
  - reset
```
public void reset()
```
  - isEmpty
```
public boolean isEmpty()
```
  - size
```
public int size()
```
    Returns the peers total number.
    
    返回:
    
    total num of peers
  - iterator
```
public Iterator<PeerId> iterator()
```
    指定者:
    
    iterator 在接口中 Iterable<PeerId>
  - getPeerSet
```
public Set<PeerId> getPeerSet()
```
  - listPeers
```
public List<PeerId> listPeers()
```
  - getPeers
```
public List<PeerId> getPeers()
```
  - setPeers
```
public void setPeers(List<PeerId> peers)
```
  - appendPeers
```
public void appendPeers(Collection<PeerId> set)
```
  - addPeer
```
public boolean addPeer(PeerId peer)
```
  - removePeer
```
public boolean removePeer(PeerId peer)
```
  - contains
```
public boolean contains(PeerId peer)
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    
    equals 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - parse
```
public boolean parse(String conf)
```
  - diff
```
public void diff(Configuration rhs,
                 Configuration included,
                 Configuration excluded)
```
    Get the difference between |*this| and |rhs| |included| would be assigned to |*this| - |rhs| |excluded| would be assigned to |rhs| - |*this|

类 Configuration

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 java.lang.Iterable

构造器详细资料

Configuration

Configuration

Configuration

Configuration

方法详细资料

setLearners

addLearner

addLearners

removeLearner

getLearners

listLearners

copy

isValid

reset

isEmpty

size

iterator

getPeerSet

listPeers

getPeers

setPeers

appendPeers

addPeer

removePeer

contains

hashCode

equals

toString

parse

diff