Record Class DataComponentPredicate.WrittenBook

java.lang.Object

java.lang.Record

net.minestom.server.instance.block.predicate.DataComponentPredicate.WrittenBook

Record Components:

pages - Predicates to match against the book's pages, or null to ignore

author - The expected author, or null to ignore

title - The expected title, or null to ignore

generation - The expected generation, or null to ignore

resolved - The expected value of WrittenBookContent.resolved(), or null to ignore

All Implemented Interfaces:

Predicate<DataComponent.Holder>, DataComponentPredicate, DataComponentPredicate.Registered

Enclosing interface:

DataComponentPredicate

public static record DataComponentPredicate.WrittenBook(@Nullable CollectionPredicate<FilteredText<Component>, DataComponentPredicate.WrittenBook.PagePredicate> pages, @Nullable String author, @Nullable String title, Range.Int generation, @Nullable Boolean resolved)
extends Record
implements DataComponentPredicate.Registered

Tests the content of pages in the DataComponents.WRITTEN_BOOK_CONTENT component.

See Also:

• CollectionPredicate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DataComponentPredicate.WrittenBook.PagePredicate

Nested classes/interfaces inherited from interface DataComponentPredicate

DataComponentPredicate.ArmorTrim, DataComponentPredicate.AttributeModifierPredicate, DataComponentPredicate.AttributeModifiers, DataComponentPredicate.BundleContents, DataComponentPredicate.Container, DataComponentPredicate.CustomData, DataComponentPredicate.Damage, DataComponentPredicate.EnchantmentListPredicate, DataComponentPredicate.Enchantments, DataComponentPredicate.Exists, DataComponentPredicate.FireworkExplosion, DataComponentPredicate.FireworkExplosionPredicate, DataComponentPredicate.Fireworks, DataComponentPredicate.JukeboxPlayable, DataComponentPredicate.Potions, DataComponentPredicate.Registered, DataComponentPredicate.StoredEnchantments, DataComponentPredicate.VillagerVariant, DataComponentPredicate.WritableBook, DataComponentPredicate.WrittenBook

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<DataComponentPredicate.WrittenBook>	CODEC

Constructor Summary

Constructors

Constructor	Description
WrittenBook(@Nullable CollectionPredicate<FilteredText<Component>, DataComponentPredicate.WrittenBook.PagePredicate> pages, @Nullable String author, @Nullable String title, Range.Int generation, @Nullable Boolean resolved)	Creates an instance of a WrittenBook record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	author()	Returns the value of the author record component.
Codec<DataComponentPredicate.WrittenBook>	codec()	Returns the codec registered for this predicate type.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Range.Int	generation()	Returns the value of the generation record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable CollectionPredicate<FilteredText<Component>, DataComponentPredicate.WrittenBook.PagePredicate>	pages()	Returns the value of the pages record component.
@Nullable Boolean	resolved()	Returns the value of the resolved record component.
boolean	test(DataComponent.Holder holder)
@Nullable 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 Object

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

Methods inherited from interface Predicate

and, negate, or

Field Details

CODEC

public static final Codec<DataComponentPredicate.WrittenBook> CODEC

Constructor Details

WrittenBook

public WrittenBook(@Nullable
 @Nullable CollectionPredicate<FilteredText<Component>, DataComponentPredicate.WrittenBook.PagePredicate> pages,
 @Nullable
 @Nullable String author,
 @Nullable
 @Nullable String title,
 @Nullable
 Range.Int generation,
 @Nullable
 @Nullable Boolean resolved)

Creates an instance of a WrittenBook record class.

Parameters:

pages - the value for the pages record component

author - the value for the author record component

title - the value for the title record component

generation - the value for the generation record component

resolved - the value for the resolved record component

Method Details

test

public boolean test(DataComponent.Holder holder)

Specified by:

test in interface Predicate<DataComponent.Holder>

codec

public Codec<DataComponentPredicate.WrittenBook> codec()

Description copied from interface: DataComponentPredicate.Registered

Returns the codec registered for this predicate type.

Specified by:

codec in interface DataComponentPredicate.Registered

Returns:

the predicate codec

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.

pages

@Nullable
public @Nullable CollectionPredicate<FilteredText<Component>, DataComponentPredicate.WrittenBook.PagePredicate> pages()

Returns the value of the pages record component.

Returns:

the value of the pages record component

author

@Nullable
public @Nullable String author()

Returns the value of the author record component.

Returns:

the value of the author record component

title

@Nullable
public @Nullable String title()

Returns the value of the title record component.

Returns:

the value of the title record component

generation

@Nullable
public Range.Int generation()

Returns the value of the generation record component.

Returns:

the value of the generation record component

resolved

@Nullable
public @Nullable Boolean resolved()

Returns the value of the resolved record component.

Returns:

the value of the resolved record component