Record Class TextPage.Item

java.lang.Object

java.lang.Record

net.ixdarklord.folios.internal.client.page.TextPage.Item

Enclosing class:

TextPage

public static record TextPage.Item(FoliosPageElement element, ElementLayout settings, @Nullable Observed observed, @Nullable String marker, FoliosLock lock)
extends Record

Constructor Summary

Constructors

Constructor	Description
Item(FoliosPageElement element, ElementLayout settings, @Nullable Observed observed)
Item(FoliosPageElement element, ElementLayout settings, @Nullable Observed observed, @Nullable String marker, FoliosLock lock)	Creates an instance of a Item record class.

Method Summary

Modifier and Type	Method	Description
FoliosPageElement	element()	Returns the value of the element record component.
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.
FoliosLock	lock()	Returns the value of the lock record component.
@Nullable String	marker()	Returns the value of the marker record component.
@Nullable Observed	observed()	Returns the value of the observed record component.
ElementLayout	settings()	Returns the value of the settings record component.
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

Item

public Item(FoliosPageElement element,
 ElementLayout settings,
 @Nullable Observed observed)

Item

public Item(FoliosPageElement element,
 ElementLayout settings,
 @Nullable Observed observed,
 @Nullable String marker,
 FoliosLock lock)

Creates an instance of a Item record class.

Parameters:

element - the value for the element record component

settings - the value for the settings record component

observed - the value for the observed record component

marker - the value for the marker record component

lock - the value for the lock record component

Method Details

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 Objects::equals(Object,Object).

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.

element

public FoliosPageElement element()

Returns the value of the element record component.

Returns:

the value of the element record component

settings

public ElementLayout settings()

Returns the value of the settings record component.

Returns:

the value of the settings record component

observed

public @Nullable Observed observed()

Returns the value of the observed record component.

Returns:

the value of the observed record component

marker

public @Nullable String marker()

Returns the value of the marker record component.

Returns:

the value of the marker record component

lock

public FoliosLock lock()

Returns the value of the lock record component.

Returns:

the value of the lock record component