io.atomix.protocols.raft.protocol

Class AppendRequest.Builder

java.lang.Object

io.atomix.protocols.raft.protocol.AppendRequest.Builder

All Implemented Interfaces:

RaftRequest.Builder<AppendRequest.Builder,AppendRequest>, io.atomix.utils.Builder<AppendRequest>

Enclosing class:

AppendRequest

public static class AppendRequest.Builder
extends Object

Append request builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AppendRequest.Builder	addEntry(RaftLogEntry entry) Adds an entry to the request.
AppendRequest	build()
AppendRequest.Builder	withCommitIndex(long commitIndex) Sets the request commit index.
AppendRequest.Builder	withEntries(List<RaftLogEntry> entries) Sets the request entries.
AppendRequest.Builder	withEntries(RaftLogEntry... entries) Sets the request entries.
AppendRequest.Builder	withLeader(MemberId leader) Sets the request leader.
AppendRequest.Builder	withPrevLogIndex(long prevLogIndex) Sets the request last log index.
AppendRequest.Builder	withPrevLogTerm(long prevLogTerm) Sets the request last log term.
AppendRequest.Builder	withTerm(long term) Sets the request term.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withTerm

public AppendRequest.Builder withTerm(long term)

Sets the request term.

Parameters:

term - The request term.

Returns:

The append request builder.

Throws:

IllegalArgumentException - if the term is not positive

withLeader

public AppendRequest.Builder withLeader(MemberId leader)

Sets the request leader.

Parameters:

leader - The request leader.

Returns:

The append request builder.

Throws:

IllegalArgumentException - if the leader is not positive

withPrevLogIndex

public AppendRequest.Builder withPrevLogIndex(long prevLogIndex)

Sets the request last log index.

Parameters:

prevLogIndex - The request last log index.

Returns:

The append request builder.

Throws:

IllegalArgumentException - if the index is not positive

withPrevLogTerm

public AppendRequest.Builder withPrevLogTerm(long prevLogTerm)

Sets the request last log term.

Parameters:

prevLogTerm - The request last log term.

Returns:

The append request builder.

Throws:

IllegalArgumentException - if the term is not positive

withEntries

public AppendRequest.Builder withEntries(RaftLogEntry... entries)

Sets the request entries.

Parameters:

entries - The request entries.

Returns:

The append request builder.

Throws:

NullPointerException - if entries is null

withEntries

public AppendRequest.Builder withEntries(List<RaftLogEntry> entries)

Sets the request entries.

Parameters:

entries - The request entries.

Returns:

The append request builder.

Throws:

NullPointerException - if entries is null

addEntry

public AppendRequest.Builder addEntry(RaftLogEntry entry)

Adds an entry to the request.

Parameters:

entry - The entry to add.

Returns:

The request builder.

Throws:

NullPointerException - if entry is null

withCommitIndex

public AppendRequest.Builder withCommitIndex(long commitIndex)

Sets the request commit index.

Parameters:

commitIndex - The request commit index.

Returns:

The append request builder.

Throws:

IllegalArgumentException - if index is not positive

build

public AppendRequest build()

Throws:

IllegalStateException - if the term, log term, log index, commit index, or global index are not positive, or if entries is null