Package io.github.thecsdev.tcdcommons.api.registry

Class TAbstractMappedRegistry<T>

java.lang.Object

io.github.thecsdev.tcdcommons.api.registry.TAbstractMappedRegistry<T>

All Implemented Interfaces:

TRegistry<T>, Iterable<Map.Entry<net.minecraft.util.Identifier,T>>

Direct Known Subclasses:

TImmutableRegistry, TMutableRegistry, TSimpleRegistry

public abstract class TAbstractMappedRegistry<T>
extends Object
implements TRegistry<T>

A TRegistry that uses HashBiMaps to store data about registered entries.

See Also:

• TSimpleRegistry
• TMutableRegistry
• TImmutableRegistry

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TAbstractMappedRegistry.MappedRegistryEvent<T>

Field Summary

Fields

Modifier and Type	Field	Description
final TEvent<TAbstractMappedRegistry.MappedRegistryEvent<T>>	eRegistered
final TEvent<TAbstractMappedRegistry.MappedRegistryEvent<T>>	eUnRegistered
protected final Map<net.minecraft.util.Identifier,T>	map

Constructor Summary

Constructors

Constructor	Description
TAbstractMappedRegistry()

Method Summary

Modifier and Type	Method	Description
final boolean	containsKey(net.minecraft.util.Identifier id)
final boolean	containsValue(T entry)
final void	forEach(Consumer<? super Map.Entry<net.minecraft.util.Identifier,T>> action)
final Optional<net.minecraft.util.Identifier>	getKey(T entry)	Returns the unique Identifier that corresponds to a registered entry, wrapped in an Optional.
final Optional<T>	getValue(net.minecraft.util.Identifier id)	Returns a registered entry, wrapped in an Optional.
final Iterator<Map.Entry<net.minecraft.util.Identifier,T>>	iterator()
T	register(net.minecraft.util.Identifier id, T entry)	Registers an entry to this TRegistry.
final int	size()	Returns the number of registered entries in this TRegistry.
final Spliterator<Map.Entry<net.minecraft.util.Identifier,T>>	spliterator()
T	unregister(net.minecraft.util.Identifier id)	UnRegisters an existing entry that is part of this TRegistry.

Methods inherited from class java.lang.Object

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

Field Details

map

protected final Map<net.minecraft.util.Identifier,T> map

eRegistered

public final TEvent<TAbstractMappedRegistry.MappedRegistryEvent<T>> eRegistered

eUnRegistered

public final TEvent<TAbstractMappedRegistry.MappedRegistryEvent<T>> eUnRegistered

Constructor Details

TAbstractMappedRegistry

public TAbstractMappedRegistry()

Method Details

iterator

public final Iterator<Map.Entry<net.minecraft.util.Identifier,T>> iterator()

Specified by:

iterator in interface Iterable<T>

size

public final int size()

Description copied from interface: TRegistry

Returns the number of registered entries in this TRegistry.

Specified by:

size in interface TRegistry<T>

register

public T register(net.minecraft.util.Identifier id,
 T entry)
           throws UnsupportedOperationException,
NullPointerException,
IllegalStateException

Description copied from interface: TRegistry

Registers an entry to this TRegistry.

Specified by:

register in interface TRegistry<T>

Parameters:

id - The unique Identifier of the entry being registered.

entry - The entry being registered.

Returns:

The registered entry.

Throws:

UnsupportedOperationException - If this TRegistry does not support registering new entries.

NullPointerException - If any given argument is null.

IllegalStateException - If the entry is already registered, and this TRegistry doesn't support overriding existing entries.

unregister

public T unregister(net.minecraft.util.Identifier id)
             throws UnsupportedOperationException,
NullPointerException

Description copied from interface: TRegistry

UnRegisters an existing entry that is part of this TRegistry.

Specified by:

unregister in interface TRegistry<T>

Parameters:

id - The unique Identifier of the entry being unregistered.

Returns:

The entry value that was previously associated with the given unique Identifier, or null if there was no such entry.

Throws:

UnsupportedOperationException - If this TRegistry does not support unregistering existing entries.

NullPointerException - If any given argument is null.

getKey

public final Optional<net.minecraft.util.Identifier> getKey(T entry)

Description copied from interface: TRegistry

Returns the unique Identifier that corresponds to a registered entry, wrapped in an Optional.

Specified by:

getKey in interface TRegistry<T>

Parameters:

entry - The registered entry.

getValue

public final Optional<T> getValue(net.minecraft.util.Identifier id)

Description copied from interface: TRegistry

Returns a registered entry, wrapped in an Optional.

Specified by:

getValue in interface TRegistry<T>

Parameters:

id - The unique Identifier of the entry that was registered.

containsKey

public final boolean containsKey(net.minecraft.util.Identifier id)

Specified by:

containsKey in interface TRegistry<T>

containsValue

public final boolean containsValue(T entry)

Specified by:

containsValue in interface TRegistry<T>

forEach

public final void forEach(Consumer<? super Map.Entry<net.minecraft.util.Identifier,T>> action)

Specified by:

forEach in interface Iterable<T>

spliterator

public final Spliterator<Map.Entry<net.minecraft.util.Identifier,T>> spliterator()

Specified by:

spliterator in interface Iterable<T>