io.purplejs.core.registry

Interface Registry

All Known Subinterfaces:

Engine, Environment

public interface Registry

The registry acts as a simple map of components in the system. It's possible to get an instance of a provider of an instance.

Method Summary

Modifier and Type	Method and Description
<T> T	getInstance(Class<T> type) Returns a singleton instance of the supplied type.
<T> T	getInstanceOrNull(Class<T> type) Returns a singleton instance of the supplied type.
<T> Supplier<T>	getProvider(Class<T> type) Returns a provider of instances for the supplied type.

Method Detail

getInstance

<T> T getInstance(Class<T> type)

Returns a singleton instance of the supplied type. If not found, then an exception is thrown.

Type Parameters:

T - type of instance.

Parameters:

type - type of instance.

Returns:

the instance bound to the supplied type.

Throws:

IllegalArgumentException - if the instance of type cannot be found.

getInstanceOrNull

<T> T getInstanceOrNull(Class<T> type)

Returns a singleton instance of the supplied type. If not found, this method will return null.

Type Parameters:

T - type of instance.

Parameters:

type - type of instance.

Returns:

the instance bound to the supplied type or null.

getProvider

<T> Supplier<T> getProvider(Class<T> type)

Returns a provider of instances for the supplied type. This will always return a provider even if the type is not bound. If the user tries to get an instance of an unknown type, then an exception is thrown.

Type Parameters:

T - type of instance.

Parameters:

type - type of instance.

Returns:

a provider bound to the supplied type.