Package net.minecraftforge.registries

Class RegistryObject<T>

java.lang.Object

net.minecraftforge.registries.RegistryObject<T>

All Implemented Interfaces:

Supplier<T>

public final class RegistryObject<T>
extends Object
implements Supplier<T>

Field Summary

Fields

Modifier and Type	Field	Description
private static final RegistryObject<?>	EMPTY
private @Nullable Holder<T>	holder
private @Nullable ResourceKey<T>	key
private final @Nullable ResourceLocation	name
private final boolean	optionalRegistry
private T	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RegistryObject()
private	RegistryObject(ResourceLocation name, Class<V> baseType, String modid)	Deprecated, for removal: This API element is subject to removal in a future version.
private	RegistryObject(ResourceLocation name, Supplier<Class<? super V>> registryType)	Deprecated, for removal: This API element is subject to removal in a future version.
private	RegistryObject(ResourceLocation name, ResourceLocation registryName, String modid, boolean optionalRegistry)
private	RegistryObject(ResourceLocation name, IForgeRegistry<V> registry)

Method Summary

Modifier and Type	Method	Description
static <T, U extends T> RegistryObject<U>	create(ResourceLocation name, ResourceKey<? extends Registry<T>> registryKey, String modid)	Factory for a RegistryObject that stores the value of an object from a registry once it is ready based on a lookup of the provided registry key.
static <T, U extends T> RegistryObject<U>	create(ResourceLocation name, ResourceLocation registryName, String modid)	Factory for a RegistryObject that stores the value of an object from a registry once it is ready based on a lookup of the provided registry name.
static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U>	create(ResourceLocation name, IForgeRegistry<T> registry)	Factory for a RegistryObject that stores the value of an object from the provided forge registry once it is ready.
static <T, U extends T> RegistryObject<U>	createOptional(ResourceLocation name, ResourceKey<? extends Registry<T>> registryKey, String modid)	Factory for a RegistryObject that optionally stores the value of an object from a registry once it is ready if the registry exists based on a lookup of the provided registry key.
static <T, U extends T> RegistryObject<U>	createOptional(ResourceLocation name, ResourceLocation registryName, String modid)	Factory for a RegistryObject that optionally stores the value of an object from a registry once it is ready if the registry exists based on a lookup of the provided registry name.
private static <T> RegistryObject<T>	empty()
boolean	equals(Object obj)
RegistryObject<T>	filter(Predicate<? super T> predicate)	If a mod object is present, and the mod object matches the given predicate, return an RegistryObject describing the value, otherwise return an empty RegistryObject.
<U> Optional<U>	flatMap(Function<? super T,Optional<U>> mapper)	If a value is present, apply the provided Optional-bearing mapping function to it, return that result, otherwise return an empty Optional.
T	get()	Retrieves the wrapped object in the registry.
@NotNull Optional<Holder<T>>	getHolder()	Returns an optional Holder instance pointing to this RegistryObject's name and value.
ResourceLocation	getId()
@Nullable ResourceKey<T>	getKey()	Returns the resource key that points to the registry and name of this registry object.
int	hashCode()
void	ifPresent(Consumer<? super T> consumer)	If a mod object is present, invoke the specified consumer with the object, otherwise do nothing.
boolean	isPresent()	Return true if there is a mod object present, otherwise false.
<U> Supplier<U>	lazyMap(Function<? super T,? extends U> mapper)	If a mod object is present, lazily apply the provided mapping function to it, returning a supplier for the transformed result.
<U> Optional<U>	map(Function<? super T,? extends U> mapper)	If a mod object is present, apply the provided mapping function to it, and if the result is non-null, return an Optional describing the result.
static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U>	of(ResourceLocation name, Class<T> baseType, String modid)	Deprecated, for removal: This API element is subject to removal in a future version. The uniqueness of registry super types will not be guaranteed starting in 1.19.
static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U>	of(ResourceLocation name, Supplier<Class<? super T>> registryType)	Deprecated, for removal: This API element is subject to removal in a future version. The uniqueness of registry super types will not be guaranteed starting in 1.19.
static <T, U extends T> RegistryObject<U>	of(ResourceLocation name, ResourceKey<? extends Registry<T>> registryKey, String modid)	Deprecated, for removal: This API element is subject to removal in a future version. Use create(ResourceLocation, ResourceKey, String) instead.
static <T, U extends T> RegistryObject<U>	of(ResourceLocation name, ResourceLocation registryName, String modid)	Deprecated, for removal: This API element is subject to removal in a future version. Use create(ResourceLocation, ResourceLocation, String) instead.
static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U>	of(ResourceLocation name, IForgeRegistry<T> registry)	Deprecated, for removal: This API element is subject to removal in a future version. Use create(ResourceLocation, IForgeRegistry) instead.
T	orElse(T other)	Return the mod object if present, otherwise return other.
T	orElseGet(Supplier<? extends T> other)	Return the mod object if present, otherwise invoke other and return the result of that invocation.
<X extends Throwable> T	orElseThrow(Supplier<? extends X> exceptionSupplier)	Return the contained mod object, if present, otherwise throw an exception to be created by the provided supplier.
private static boolean	registryExists(ResourceLocation registryName)
Stream<T>	stream()
(package private) void	updateReference(Registry<? extends T> registry)
(package private) void	updateReference(ResourceLocation registryName)
void	updateReference(IForgeRegistry<? extends T> registry)	Deprecated.

Methods inherited from class java.lang.Object

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

Field Details

name

@Nullable
private final @Nullable ResourceLocation name

key

@Nullable
private @Nullable ResourceKey<T> key

optionalRegistry

private final boolean optionalRegistry

value

@Nullable
private T value

holder

@Nullable
private @Nullable Holder<T> holder

EMPTY

private static final RegistryObject<?> EMPTY

Constructor Details

RegistryObject

private RegistryObject()

RegistryObject

@Deprecated(forRemoval=true,
            since="1.18.2")
private RegistryObject(ResourceLocation name,
 Supplier<Class<? super V>> registryType)

Deprecated, for removal: This API element is subject to removal in a future version.

RegistryObject

private RegistryObject(ResourceLocation name,
 IForgeRegistry<V> registry)

RegistryObject

@Deprecated(forRemoval=true,
            since="1.18.2")
private RegistryObject(ResourceLocation name,
 Class<V> baseType,
 String modid)

Deprecated, for removal: This API element is subject to removal in a future version.

RegistryObject

private RegistryObject(ResourceLocation name,
 ResourceLocation registryName,
 String modid,
 boolean optionalRegistry)

Method Details

of

@Deprecated(forRemoval=true,
            since="1.18.2")
public static <T extends IForgeRegistryEntry<T>,
U extends T>
RegistryObject<U> of(ResourceLocation name,
 Supplier<Class<? super T>> registryType)

Deprecated, for removal: This API element is subject to removal in a future version.

The uniqueness of registry super types will not be guaranteed starting in 1.19. Use create(ResourceLocation, ResourceLocation, String).

of

@Deprecated(forRemoval=true,
            since="1.18.2")
public static <T extends IForgeRegistryEntry<T>,
U extends T>
RegistryObject<U> of(ResourceLocation name,
 IForgeRegistry<T> registry)

Deprecated, for removal: This API element is subject to removal in a future version.

Use create(ResourceLocation, IForgeRegistry) instead.

Factory for a RegistryObject that stores the value of an object from the provided forge registry once it is ready.

Parameters:

name - the name of the object to look up in the forge registry

registry - the forge registry

Returns:

a RegistryObject that stores the value of an object from the provided forge registry once it is ready

create

public static <T extends IForgeRegistryEntry<T>,
U extends T>
RegistryObject<U> create(ResourceLocation name,
 IForgeRegistry<T> registry)

Factory for a RegistryObject that stores the value of an object from the provided forge registry once it is ready.

Parameters:

name - the name of the object to look up in the forge registry

registry - the forge registry

Returns:

a RegistryObject that stores the value of an object from the provided forge registry once it is ready

of

@Deprecated(forRemoval=true,
            since="1.18.2")
public static <T extends IForgeRegistryEntry<T>,
U extends T>
RegistryObject<U> of(ResourceLocation name,
 Class<T> baseType,
 String modid)

Deprecated, for removal: This API element is subject to removal in a future version.

The uniqueness of registry super types will not be guaranteed starting in 1.19. Use create(ResourceLocation, ResourceLocation, String).

of

@Deprecated(forRemoval=true,
            since="1.18.2")
public static <T,
U extends T> RegistryObject<U> of(ResourceLocation name,
 ResourceKey<? extends Registry<T>> registryKey,
 String modid)

Deprecated, for removal: This API element is subject to removal in a future version.

Use create(ResourceLocation, ResourceKey, String) instead.

Factory for a RegistryObject that stores the value of an object from a registry once it is ready based on a lookup of the provided registry key.

If a registry with the given key cannot be found, an exception will be thrown when trying to fill this RegistryObject. Use createOptional(ResourceLocation, ResourceKey, String) for RegistryObjects of optional registries.

Parameters:

name - the name of the object to look up in a registry

registryKey - the key of the registry. Supports lookups on BuiltinRegistries, Registry, and RegistryManager.ACTIVE.

modid - the mod id calling context

Returns:

a RegistryObject that stores the value of an object from a registry once it is ready

See Also:

• createOptional(ResourceLocation, ResourceKey, String)
• create(ResourceLocation, IForgeRegistry)
• create(ResourceLocation, ResourceLocation, String)

create

public static <T,
U extends T> RegistryObject<U> create(ResourceLocation name,
 ResourceKey<? extends Registry<T>> registryKey,
 String modid)

Factory for a RegistryObject that stores the value of an object from a registry once it is ready based on a lookup of the provided registry key.

If a registry with the given key cannot be found, an exception will be thrown when trying to fill this RegistryObject. Use createOptional(ResourceLocation, ResourceKey, String) for RegistryObjects of optional registries.

Parameters:

name - the name of the object to look up in a registry

registryKey - the key of the registry. Supports lookups on BuiltinRegistries, Registry, and RegistryManager.ACTIVE.

modid - the mod id calling context

Returns:

a RegistryObject that stores the value of an object from a registry once it is ready

See Also:

• createOptional(ResourceLocation, ResourceKey, String)
• create(ResourceLocation, IForgeRegistry)
• create(ResourceLocation, ResourceLocation, String)

createOptional

public static <T,
U extends T> RegistryObject<U> createOptional(ResourceLocation name,
 ResourceKey<? extends Registry<T>> registryKey,
 String modid)

Factory for a RegistryObject that optionally stores the value of an object from a registry once it is ready if the registry exists based on a lookup of the provided registry key.

If a registry with the given key cannot be found, it will be silently ignored and this RegistryObject will not be filled. Use create(ResourceLocation, ResourceKey, String) for RegistryObjects that should throw exceptions on missing registry.

Parameters:

name - the name of the object to look up in a registry

registryKey - the key of the registry. Supports lookups on BuiltinRegistries, Registry, and RegistryManager.ACTIVE.

modid - the mod id calling context

Returns:

a RegistryObject that stores the value of an object from a registry once it is ready

See Also:

• create(ResourceLocation, ResourceKey, String)
• create(ResourceLocation, IForgeRegistry)
• create(ResourceLocation, ResourceLocation, String)

of

@Deprecated(forRemoval=true,
            since="1.18.2")
public static <T,
U extends T> RegistryObject<U> of(ResourceLocation name,
 ResourceLocation registryName,
 String modid)

Deprecated, for removal: This API element is subject to removal in a future version.

Use create(ResourceLocation, ResourceLocation, String) instead.

Factory for a RegistryObject that stores the value of an object from a registry once it is ready based on a lookup of the provided registry name.

If a registry with the given name cannot be found, an exception will be thrown when trying to fill this RegistryObject. Use createOptional(ResourceLocation, ResourceLocation, String) for RegistryObjects of optional registries.

Parameters:

name - the name of the object to look up in a registry

registryName - the name of the registry. Supports lookups on BuiltinRegistries, Registry, and RegistryManager.ACTIVE.

modid - the mod id calling context

Returns:

a RegistryObject that stores the value of an object from a registry once it is ready

See Also:

• createOptional(ResourceLocation, ResourceLocation, String)
• create(ResourceLocation, IForgeRegistry)
• create(ResourceLocation, ResourceKey, String)

create

public static <T,
U extends T> RegistryObject<U> create(ResourceLocation name,
 ResourceLocation registryName,
 String modid)

Factory for a RegistryObject that stores the value of an object from a registry once it is ready based on a lookup of the provided registry name.

If a registry with the given name cannot be found, an exception will be thrown when trying to fill this RegistryObject. Use createOptional(ResourceLocation, ResourceLocation, String) for RegistryObjects of optional registries.

Parameters:

name - the name of the object to look up in a registry

registryName - the name of the registry. Supports lookups on BuiltinRegistries, Registry, and RegistryManager.ACTIVE.

modid - the mod id calling context

Returns:

a RegistryObject that stores the value of an object from a registry once it is ready

See Also:

• createOptional(ResourceLocation, ResourceLocation, String)
• create(ResourceLocation, IForgeRegistry)
• create(ResourceLocation, ResourceKey, String)

createOptional

public static <T,
U extends T> RegistryObject<U> createOptional(ResourceLocation name,
 ResourceLocation registryName,
 String modid)

Factory for a RegistryObject that optionally stores the value of an object from a registry once it is ready if the registry exists based on a lookup of the provided registry name.

If a registry with the given name cannot be found, it will be silently ignored and this RegistryObject will not be filled. Use create(ResourceLocation, ResourceLocation, String) for RegistryObjects that should throw exceptions on missing registry.

Parameters:

name - the name of the object to look up in a registry

registryName - the name of the registry. Supports lookups on BuiltinRegistries, Registry, and RegistryManager.ACTIVE.

modid - the mod id calling context

Returns:

a RegistryObject that stores the value of an object from a registry once it is ready

See Also:

• create(ResourceLocation, ResourceLocation, String)
• create(ResourceLocation, IForgeRegistry)
• create(ResourceLocation, ResourceKey, String)

empty

private static <T> RegistryObject<T> empty()

get

@NotNull
public T get()

Retrieves the wrapped object in the registry. This value will automatically be updated when the backing registry is updated.

Specified by:

get in interface Supplier<T>

Throws:

NullPointerException - If the value is null. Use isPresent() to check if the value exists first.

See Also:

• isPresent()
• orElse(Object)
• orElseGet(Supplier)
• orElseThrow(Supplier)

updateReference

@Deprecated(since="1.18.1")
public void updateReference(IForgeRegistry<? extends T> registry)

Deprecated.

updateReference

void updateReference(Registry<? extends T> registry)

updateReference

void updateReference(ResourceLocation registryName)

registryExists

private static boolean registryExists(ResourceLocation registryName)

getId

public ResourceLocation getId()

getKey

@Nullable
public @Nullable ResourceKey<T> getKey()

Returns the resource key that points to the registry and name of this registry object. Nullable only when the deprecated factories of(ResourceLocation, Class, String) or of(ResourceLocation, Supplier) are used.

Returns:

the resource key that points to the registry and name of this registry object

stream

public Stream<T> stream()

isPresent

public boolean isPresent()

Return true if there is a mod object present, otherwise false.

Returns:

true if there is a mod object present, otherwise false

ifPresent

public void ifPresent(Consumer<? super T> consumer)

If a mod object is present, invoke the specified consumer with the object, otherwise do nothing.

Parameters:

consumer - block to be executed if a mod object is present

Throws:

NullPointerException - if mod object is present and consumer is null

filter

public RegistryObject<T> filter(Predicate<? super T> predicate)

If a mod object is present, and the mod object matches the given predicate, return an RegistryObject describing the value, otherwise return an empty RegistryObject.

Parameters:

predicate - a predicate to apply to the mod object, if present

Returns:

an RegistryObject describing the value of this RegistryObject if a mod object is present and the mod object matches the given predicate, otherwise an empty RegistryObject

Throws:

NullPointerException - if the predicate is null

map

public <U> Optional<U> map(Function<? super T,? extends U> mapper)

If a mod object is present, apply the provided mapping function to it, and if the result is non-null, return an Optional describing the result. Otherwise return an empty Optional.

Type Parameters:

U - The type of the result of the mapping function

Parameters:

mapper - a mapping function to apply to the mod object, if present

Returns:

an Optional describing the result of applying a mapping function to the mod object of this RegistryObject, if a mod object is present, otherwise an empty Optional

Throws:

NullPointerException - if the mapping function is null

flatMap

public <U> Optional<U> flatMap(Function<? super T,Optional<U>> mapper)

If a value is present, apply the provided Optional-bearing mapping function to it, return that result, otherwise return an empty Optional. This method is similar to map(Function), but the provided mapper is one whose result is already an Optional, and if invoked, flatMap does not wrap it with an additional Optional.

Type Parameters:

U - The type parameter to the Optional returned by

Parameters:

mapper - a mapping function to apply to the mod object, if present the mapping function

Returns:

the result of applying an Optional-bearing mapping function to the value of this Optional, if a value is present, otherwise an empty Optional

Throws:

NullPointerException - if the mapping function is null or returns a null result

lazyMap

public <U> Supplier<U> lazyMap(Function<? super T,? extends U> mapper)

If a mod object is present, lazily apply the provided mapping function to it, returning a supplier for the transformed result. If this object is empty, or the mapping function returns null, the supplier will return null.

Type Parameters:

U - The type of the result of the mapping function

Parameters:

mapper - A mapping function to apply to the mod object, if present

Returns:

A Supplier lazily providing the result of applying a mapping function to the mod object of this RegistryObject, if a mod object is present, otherwise a supplier returning null

Throws:

NullPointerException - if the mapping function is null

orElse

public T orElse(T other)

Return the mod object if present, otherwise return other.

Parameters:

other - the mod object to be returned if there is no mod object present, may be null

Returns:

the mod object, if present, otherwise other

orElseGet

public T orElseGet(Supplier<? extends T> other)

Return the mod object if present, otherwise invoke other and return the result of that invocation.

Parameters:

other - a Supplier whose result is returned if no mod object is present

Returns:

the mod object if present otherwise the result of other.get()

Throws:

NullPointerException - if mod object is not present and other is null

orElseThrow

public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)
                                    throws X

Return the contained mod object, if present, otherwise throw an exception to be created by the provided supplier.

Type Parameters:

X - Type of the exception to be thrown

Parameters:

exceptionSupplier - The supplier which will return the exception to be thrown

Returns:

the present mod object

Throws:

X - if there is no mod object present

NullPointerException - if no mod object is present and exceptionSupplier is null

getHolder

@NotNull
public @NotNull Optional<Holder<T>> getHolder()

Returns an optional Holder instance pointing to this RegistryObject's name and value.

This should only be used in cases where vanilla code requires passing in a Holder. Mod-written code should rely on RegistryObjects or Suppliers instead.

The returned optional will be empty if the registry does not exist or if the deprecated factories of(ResourceLocation, Class, String) or of(ResourceLocation, Supplier) are used. Otherwise, the optional Holder will be present even if isPresent() returns false.

Returns:

an optional Holder instance pointing to this RegistryObject's name and value

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object