Package net.minestom.server.item.component

Record Class WrittenBookContent

java.lang.Object

java.lang.Record

net.minestom.server.item.component.WrittenBookContent

public record WrittenBookContent(@NotNull FilteredText<String> title, @NotNull String author, int generation, @NotNull List<FilteredText<Component>> pages, boolean resolved)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final WrittenBookContent	EMPTY
static final @NotNull BinaryTagSerializer<WrittenBookContent>	NBT_TYPE
static final NetworkBuffer.Type<WrittenBookContent>	NETWORK_TYPE

Constructor Summary

Constructors

Constructor	Description
WrittenBookContent(@NotNull String title, @NotNull String author, int generation, @NotNull List<Component> pages, boolean resolved)
WrittenBookContent(@NotNull String title, @NotNull String author, @NotNull List<Component> pages)
WrittenBookContent(@NotNull FilteredText<String> title, @NotNull String author, int generation, @NotNull List<FilteredText<Component>> pages, boolean resolved)	Creates an instance of a WrittenBookContent record class.

Method Summary

Modifier and Type	Method	Description
@NotNull String	author()	Returns the value of the author record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	generation()	Returns the value of the generation record component.
final int	hashCode()	Returns a hash code value for this object.
@NotNull List<FilteredText<Component>>	pages()	Returns the value of the pages record component.
boolean	resolved()	Returns the value of the resolved record component.
@NotNull FilteredText<String>	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final WrittenBookContent EMPTY

NETWORK_TYPE

public static final NetworkBuffer.Type<WrittenBookContent> NETWORK_TYPE

NBT_TYPE

@NotNull
public static final @NotNull BinaryTagSerializer<WrittenBookContent> NBT_TYPE

Constructor Details

WrittenBookContent

public WrittenBookContent(@NotNull
 @NotNull FilteredText<String> title,
 @NotNull
 @NotNull String author,
 int generation,
 @NotNull
 @NotNull List<FilteredText<Component>> pages,
 boolean resolved)

Creates an instance of a WrittenBookContent record class.

Parameters:

title - the value for the title record component

author - the value for the author record component

generation - the value for the generation record component

pages - the value for the pages record component

resolved - the value for the resolved record component

WrittenBookContent

public WrittenBookContent(@NotNull
 @NotNull String title,
 @NotNull
 @NotNull String author,
 @NotNull
 @NotNull List<Component> pages)

WrittenBookContent

public WrittenBookContent(@NotNull
 @NotNull String title,
 @NotNull
 @NotNull String author,
 int generation,
 @NotNull
 @NotNull List<Component> pages,
 boolean resolved)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

title

@NotNull
public @NotNull FilteredText<String> title()

Returns the value of the title record component.

Returns:

the value of the title record component

author

@NotNull
public @NotNull String author()

Returns the value of the author record component.

Returns:

the value of the author record component

generation

public int generation()

Returns the value of the generation record component.

Returns:

the value of the generation record component

pages

@NotNull
public @NotNull List<FilteredText<Component>> pages()

Returns the value of the pages record component.

Returns:

the value of the pages record component

resolved

public boolean resolved()

Returns the value of the resolved record component.

Returns:

the value of the resolved record component