Class LoaderEnvironmentRegistry

java.lang.Object

dev.jaxydog.lodestone.impl.LoaderEnvironmentRegistry

public final class LoaderEnvironmentRegistry
extends Object

Retains information about all registered loader environments.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final AtomicBoolean	FORBID_BUNDLED	Tracks whether Lodestone has finished initializing bundled environments and should forbid new bundled interfaces from being loaded.

Method Summary

Modifier and Type	Method	Description
<T extends Loaded> void	addEntrypoint(Class<? extends T> type, T entrypoint)	Adds an entrypoint to the LoaderEnvironmentRegistry instance associated with the given Loaded interface.
static LoaderEnvironmentRegistry	create()	Creates a new, empty LoaderEnvironmentRegistry instance.
Set<Class<? extends Loaded>>	getInterfaces()	Returns a set containing all registered interface instances.
<T extends Loaded> boolean	has(Class<? extends T> type)	Returns whether a LoaderEnvironment for the given Loaded interface was previously registered.
<T extends Loaded> void	loadEntrypoints(Class<? extends T> type, String modId)	Loads the LoaderEnvironment instance associated with the given Loaded interface.
<T extends Loaded> void	register(LoaderEnvironment<T> environment)	Registers the given LoaderEnvironment.

Methods inherited from class java.lang.Object

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

Field Details

FORBID_BUNDLED

public static final AtomicBoolean FORBID_BUNDLED

Tracks whether Lodestone has finished initializing bundled environments and should forbid new bundled interfaces from being loaded.

Since:

1.6.0

Method Details

create

public static LoaderEnvironmentRegistry create()

Creates a new, empty LoaderEnvironmentRegistry instance.

Returns:

A new LoaderEnvironmentRegistry instance.

Since:

1.0.0

register

public <T extends Loaded> void register(LoaderEnvironment<T> environment)
                                 throws IllegalArgumentException,
NullPointerException

Registers the given LoaderEnvironment.

Type Parameters:

T - The type of the associated Loaded interface.

Parameters:

environment - The environment instance.

Throws:

IllegalArgumentException - If the given environment's associated Loaded interface has already been registered, or if the given environment's associated Loaded type is not an interface. This may also be thrown when attempting to register a new "bundled" environment.

NullPointerException - If the given environment is null.

Since:

1.0.0

has

public <T extends Loaded> boolean has(Class<? extends T> type)

Returns whether a LoaderEnvironment for the given Loaded interface was previously registered.

Type Parameters:

T - The type of the associated Loaded interface.

Parameters:

type - The expected Loaded interface.

Returns:

Whether a LoaderEnvironment was previously registered.

Since:

1.0.0

getInterfaces

public Set<Class<? extends Loaded>> getInterfaces()

Returns a set containing all registered interface instances.

Returns:

A set containing all registered interface instances.

Since:

0.1.0

addEntrypoint

public <T extends Loaded> void addEntrypoint(Class<? extends T> type,
 T entrypoint)
                                      throws IllegalArgumentException,
NullPointerException

Adds an entrypoint to the LoaderEnvironmentRegistry instance associated with the given Loaded interface.

Type Parameters:

T - The type of the associated Loaded interface.

Parameters:

type - The expected Loaded interface.

entrypoint - The entrypoint.

Throws:

IllegalArgumentException - If the given Loaded interface does not have a registered LoaderEnvironment.

NullPointerException - If the given entrypoint is null.

Since:

1.0.0

loadEntrypoints

public <T extends Loaded> void loadEntrypoints(Class<? extends T> type,
 String modId)
                                        throws IllegalArgumentException

Loads the LoaderEnvironment instance associated with the given Loaded interface.

If the defined LoaderEnvironment.loadValue(Loaded) method throws, the thrown error will be bubbled up.

Type Parameters:

T - The type of the associated Loaded interface.

Parameters:

type - The expected Loaded interface.

modId - The loaded mod's identifier.

Throws:

IllegalArgumentException - If the given Loaded interface does not have a registered LoaderEnvironment.

Since:

1.0.0