Record Class CollectionPredicate<T, P extends Predicate<T>>

java.lang.Object

java.lang.Record

net.minestom.server.instance.block.predicate.CollectionPredicate<T,P>

Type Parameters:

T - Type of item in the collection

P - A Predicate that matches against items of type T

Record Components:

contains - A set of sub-predicates which all must return true for this CollectionPredicate to return true

counts - A set of sub-predicates which all must match a certain number of times for this CollectionPredicate to return true

size - An acceptable range for the collection's size

All Implemented Interfaces:

Predicate<Collection<T>>

public record CollectionPredicate<T, P extends Predicate<T>>(@Nullable CollectionPredicate.Contains<T, P extends Predicate<T>> contains, @Nullable CollectionPredicate.Count<T, P extends Predicate<T>> counts, Range.Int size)
extends Record
implements Predicate<Collection<T>>

A generic predicate to match against a collection of items.

If any fields are null, they are ignored in test(Collection). If all fields are null, test(Collection) returns true.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CollectionPredicate.Builder<T, P extends Predicate<T>>
static final record	CollectionPredicate.Contains<T, P extends Predicate<T>>	A predicate that requires that all of its sub-predicates match at least once.
static final record	CollectionPredicate.Count<T, P extends Predicate<T>>	A predicate that counts the number of matching sub-predicates and tests whether it's in the count range.

Constructor Summary

Constructors

Constructor	Description
CollectionPredicate(@Nullable CollectionPredicate.Contains<T,P> contains, @Nullable CollectionPredicate.Count<T,P> counts, Range.Int size)	Creates an instance of a CollectionPredicate record class.

Method Summary

Modifier and Type	Method	Description
static <T, P extends Predicate<T>> CollectionPredicate.Builder<T,P>	builder()
static <T, P extends Predicate<T>> Codec<CollectionPredicate<T,P>>	codec(Codec<P> itemCodec)
@Nullable CollectionPredicate.Contains<T,P>	contains()	Returns the value of the contains record component.
@Nullable CollectionPredicate.Count<T,P>	counts()	Returns the value of the counts 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.
Range.Int	size()	Returns the value of the size record component.
boolean	test(Collection<T> collection)
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

Constructor Details

CollectionPredicate

public CollectionPredicate(@Nullable
 @Nullable CollectionPredicate.Contains<T,P> contains,
 @Nullable
 @Nullable CollectionPredicate.Count<T,P> counts,
 @Nullable
 Range.Int size)

Creates an instance of a CollectionPredicate record class.

Parameters:

contains - the value for the contains record component

counts - the value for the counts record component

size - the value for the size record component

Method Details

codec

public static <T, P extends Predicate<T>>
Codec<CollectionPredicate<T,P>> codec(Codec<P> itemCodec)

test

public boolean test(Collection<T> collection)

Specified by:

test in interface Predicate<T>

builder

@Contract(pure=true)
public static <T, P extends Predicate<T>>
CollectionPredicate.Builder<T,P> builder()

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.

contains

@Nullable
public @Nullable CollectionPredicate.Contains<T,P> contains()

Returns the value of the contains record component.

Returns:

the value of the contains record component

counts

@Nullable
public @Nullable CollectionPredicate.Count<T,P> counts()

Returns the value of the counts record component.

Returns:

the value of the counts record component

size

@Nullable
public Range.Int size()

Returns the value of the size record component.

Returns:

the value of the size record component