Record Class RaftInvariantChecker.InvariantResult

java.lang.Object

java.lang.Record

com.loomcache.server.consensus.RaftInvariantChecker.InvariantResult

Record Components:

valid - whether the invariant holds

violation - description of the violation (null if valid)

Enclosing class:

RaftInvariantChecker

public static record RaftInvariantChecker.InvariantResult(boolean valid, @Nullable String violation)
extends Record

Result of an invariant check.

Constructor Summary

Constructors

Constructor	Description
InvariantResult(boolean valid, @Nullable String violation)	Creates an instance of a InvariantResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static RaftInvariantChecker.InvariantResult	ok()
final String	toString()	Returns a string representation of this record class.
boolean	valid()	Returns the value of the valid record component.
@Nullable String	violation()	Returns the value of the violation record component.
static RaftInvariantChecker.InvariantResult	violation(String msg)

Methods inherited from class Object

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

Constructor Details

InvariantResult

public InvariantResult(boolean valid,
 @Nullable String violation)

Creates an instance of a InvariantResult record class.

Parameters:

valid - the value for the valid record component

violation - the value for the violation record component

Method Details

ok

public static RaftInvariantChecker.InvariantResult ok()

violation

public static RaftInvariantChecker.InvariantResult violation(String msg)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

valid

public boolean valid()

Returns the value of the valid record component.

Returns:

the value of the valid record component

violation

public @Nullable String violation()

Returns the value of the violation record component.

Returns:

the value of the violation record component