Package io.papermc.paper.registry.set

Interface RegistryKeySet<T extends Keyed>

Type Parameters:

T - registry value type

All Superinterfaces:

Iterable<TypedKey<T>>, RegistrySet<T>

All Known Subinterfaces:

Tag<T>

@NonExtendable
public non-sealed interface RegistryKeySet<T extends Keyed>
extends Iterable<TypedKey<T>>, RegistrySet<T>

Represents a collection tied to a registry.

There are 2 types of registry key sets:

• Tag which is a tag from vanilla or a datapack. These are obtained via Registry.getTag(io.papermc.paper.registry.tag.TagKey).
• RegistryKeySet which is a set of keys linked to values that are present in the registry. These are created via RegistrySet.keySet(RegistryKey, Iterable) or RegistrySet.keySetFromValues(RegistryKey, Iterable).

Method Summary

Modifier and Type	Method	Description
boolean	contains(TypedKey<T> valueKey)	Checks if this set contains the value with the given key.
default Iterator<TypedKey<T>>	iterator()
@Unmodifiable Collection<T>	resolve(Registry<T> registry)	Resolve this set into a collection of values.
default int	size()	Get the size of this set.
@Unmodifiable Collection<TypedKey<T>>	values()	Get the keys for the values in this set.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.papermc.paper.registry.set.RegistrySet

isEmpty, registryKey

Method Details

size

default int size()

Description copied from interface: RegistrySet

Get the size of this set.

Specified by:

size in interface RegistrySet<T extends Keyed>

Returns:

the size

values

@Unmodifiable Collection<TypedKey<T>> values()

Get the keys for the values in this set.

Returns:

the keys

resolve

@Unmodifiable Collection<T> resolve(Registry<T> registry)

Resolve this set into a collection of values. Prefer using values().

Parameters:

registry - the registry to resolve the values from (must match RegistrySet.registryKey())

Returns:

the resolved values

See Also:

• values()
• Registry.getTagValues(TagKey)

contains

boolean contains(TypedKey<T> valueKey)

Checks if this set contains the value with the given key.

Parameters:

valueKey - the key to check

Returns:

true if the value is in this set

iterator

default Iterator<TypedKey<T>> iterator()

Specified by:

iterator in interface Iterable<T extends Keyed>