Package io.atomix.raft.protocol

Class VersionedAppendRequest.Builder

java.lang.Object

io.atomix.raft.protocol.AbstractRaftRequest.Builder<VersionedAppendRequest.Builder,VersionedAppendRequest>

io.atomix.raft.protocol.VersionedAppendRequest.Builder

All Implemented Interfaces:

RaftRequest.Builder<VersionedAppendRequest.Builder,VersionedAppendRequest>, Builder<VersionedAppendRequest>

Enclosing class:

VersionedAppendRequest

public static class VersionedAppendRequest.Builder
extends AbstractRaftRequest.Builder<VersionedAppendRequest.Builder,VersionedAppendRequest>

Append request builder.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VersionedAppendRequest	build()
protected void	validate()	Validates the builder.
VersionedAppendRequest.Builder	withCommitIndex(long commitIndex)	Sets the request commit index.
VersionedAppendRequest.Builder	withEntries(List<ReplicatableJournalRecord> entries)	Sets the request entries.
VersionedAppendRequest.Builder	withLeader(MemberId leader)	Sets the request leader.
VersionedAppendRequest.Builder	withPrevLogIndex(long prevLogIndex)	Sets the request last log index.
VersionedAppendRequest.Builder	withPrevLogTerm(long prevLogTerm)	Sets the request last log term.
VersionedAppendRequest.Builder	withTerm(long term)	Sets the request term.
VersionedAppendRequest.Builder	withVersion(int version)	Sets the request version.

Methods inherited from class io.atomix.raft.protocol.AbstractRaftRequest.Builder

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

withVersion

public VersionedAppendRequest.Builder withVersion(int version)

Sets the request version. The default is the latest version.

Parameters:

version - The request version.

Returns:

The append request builder.

Throws:

IllegalArgumentException - if the version is not positive

withTerm

public VersionedAppendRequest.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 VersionedAppendRequest.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 VersionedAppendRequest.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 VersionedAppendRequest.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 VersionedAppendRequest.Builder withEntries(List<ReplicatableJournalRecord> entries)

Sets the request entries.

Parameters:

entries - The request entries.

Returns:

The append request builder.

Throws:

NullPointerException - if entries is null

withCommitIndex

public VersionedAppendRequest.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 VersionedAppendRequest build()

Throws:

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

validate

protected void validate()

Description copied from class: AbstractRaftRequest.Builder

Validates the builder.

Overrides:

validate in class AbstractRaftRequest.Builder<VersionedAppendRequest.Builder,VersionedAppendRequest>