Package org.opendaylight.controller.cluster.raft.persisted

Class SimpleReplicatedLogEntry

java.lang.Object

org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry

All Implemented Interfaces:

Serializable, ReplicatedLogEntry

public sealed class SimpleReplicatedLogEntry
extends Object
implements ReplicatedLogEntry, Serializable

A ReplicatedLogEntry implementation.

Author:

Thomas Pantelis

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimpleReplicatedLogEntry(long index, long term, Payload payload)	Constructs an instance.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
final Payload	getData()	Returns the payload/data to be replicated.
final long	getIndex()	Returns the index of the entry.
final long	getTerm()	Returns the term of the entry.
final int	hashCode()
final boolean	isPersistencePending()	Checks if persistence is pending for this entry.
final int	serializedSize()	Return the estimate of serialized size of this entry when passed through serialization.
final void	setPersistencePending(boolean pending)	Sets whether or not persistence is pending for this entry.
final int	size()	Returns the size of the entry in bytes.
final String	toString()
final Object	writeReplace()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleReplicatedLogEntry

public SimpleReplicatedLogEntry(long index,
 long term,
 Payload payload)

Constructs an instance.

Parameters:

index - the index

term - the term

payload - the payload

Method Details

getData

public final Payload getData()

Description copied from interface: ReplicatedLogEntry

Returns the payload/data to be replicated.

Specified by:

getData in interface ReplicatedLogEntry

Returns:

the payload/data

getTerm

public final long getTerm()

Description copied from interface: ReplicatedLogEntry

Returns the term of the entry.

Specified by:

getTerm in interface ReplicatedLogEntry

Returns:

the term

getIndex

public final long getIndex()

Description copied from interface: ReplicatedLogEntry

Returns the index of the entry.

Specified by:

getIndex in interface ReplicatedLogEntry

Returns:

the index

size

public final int size()

Description copied from interface: ReplicatedLogEntry

Returns the size of the entry in bytes. An approximate number may be good enough.

Specified by:

size in interface ReplicatedLogEntry

Returns:

the size of the entry in bytes.

serializedSize

public final int serializedSize()

Description copied from interface: ReplicatedLogEntry

Return the estimate of serialized size of this entry when passed through serialization. The estimate needs to be reasonably accurate and should err on the side of caution and report a slightly-higher size in face of uncertainty.

Specified by:

serializedSize in interface ReplicatedLogEntry

Returns:

An estimate of serialized size.

isPersistencePending

public final boolean isPersistencePending()

Description copied from interface: ReplicatedLogEntry

Checks if persistence is pending for this entry.

Specified by:

isPersistencePending in interface ReplicatedLogEntry

Returns:

true if persistence is pending, false otherwise.

setPersistencePending

public final void setPersistencePending(boolean pending)

Description copied from interface: ReplicatedLogEntry

Sets whether or not persistence is pending for this entry.

Specified by:

setPersistencePending in interface ReplicatedLogEntry

Parameters:

pending - the new setting.

writeReplace

public final Object writeReplace()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object