Record Class CursorOptions

java.lang.Object

java.lang.Record

org.j7m.middleware.api.durablelog.CursorOptions

Record Components:

allowMissingStream - whether a missing stream opens as an empty cursor

All Implemented Interfaces:

Serializable

public record CursorOptions(boolean allowMissingStream)
extends Record
implements Serializable

Cursor options.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CursorOptions(boolean allowMissingStream)	Creates an instance of a CursorOptions record class.

Method Summary

Modifier and Type	Method	Description
boolean	allowMissingStream()	Returns the value of the allowMissingStream record component.
static CursorOptions	defaults()	Returns default cursor options.
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.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CursorOptions

public CursorOptions(boolean allowMissingStream)

Creates an instance of a CursorOptions record class.

Parameters:

allowMissingStream - the value for the allowMissingStream record component

Method Details

defaults

public static CursorOptions defaults()

Returns default cursor options.

Returns:

default cursor options

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. All components in this record class 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.

allowMissingStream

public boolean allowMissingStream()

Returns the value of the allowMissingStream record component.

Returns:

the value of the allowMissingStream record component