me.piggypiglet.framework.registerables

Class StartupRegisterable

java.lang.Object

me.piggypiglet.framework.registerables.StartupRegisterable

Direct Known Subclasses:

ClassLoaderRegisterable, CommandExecutorRegisterable, CommandExecutorRegisterable, CommandExecutorRegisterable, CommandExecutorRegisterable, CommandExecutorRegisterable, CommandHandlerRegisterable, CommandHandlerRegisterable, CommandsRegisterable, ConsoleRegisterable, DefaultConfigsRegisterable, EventFinderRegisterable, EventFinderRegisterable, EventFinderRegisterable, EventFinderRegisterable, EventFinderRegisterable, FileMappingRegisterable, FilesRegisterable, FileTypesRegisterable, GuildBindingRegisterable, HTTPRegisterable, ImplementationFinderRegisterable, JDARegisterable, LangFileRegisterable, LangValuesRegisterable, LoaderFinderRegisterable, LoggerRegisterable, LoggerRegisterable, LoggerRegisterable, LoggerRegisterable, LoggerRegisterable, ManagersRegisterable, MySQLRegisterable, MySQLSavingRegisterable, PacketRegisterable, PermissionRegisterable, RoutesRegisterable, ServerRegisterable, ShutdownHookRegisterable, ShutdownRegisterablesRegisterable, UserConfigsRegisterable

public abstract class StartupRegisterable
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Injector	injector

Constructor Summary

Constructors

Constructor and Description
StartupRegisterable()

Method Summary

Modifier and Type	Method and Description
protected <T> void	addAnnotatedBinding(java.lang.Class<? super T> interfaze, java.lang.annotation.Annotation annotation, T instance) Add a binding to guice that's only injectable when a specific annotation is provided.
protected <T> void	addAnnotatedBinding(java.lang.Class<? super T> interfaze, java.lang.Class<? extends java.lang.annotation.Annotation> annotation, T instance) Add a binding to guice that's only injectable when a specific annotation is provided.
protected <T> void	addBinding(java.lang.Class<? super T> interfaze, T instance) Add a binding to guice with a specific class and instance.
protected void	addBinding(java.lang.Object instance) Add a binding to guice, reference class is deduced from the instance itself.
protected <T> void	addBinding(com.google.inject.TypeLiteral<? super T> interfaze, T instance) Add a binding to guice with a specific class & generic, and instance.
protected abstract void	execute() Code to be ran on the registerable's execution.
java.util.List<AnnotatedBinding<?>>	getAnnotatedBindings() Get a list of annotated binding objects set by the registerable
java.util.Map<java.lang.Class<?>,java.lang.Object>	getBindings() Get a map of bindings to be made
java.util.Map<com.google.inject.TypeLiteral<?>,java.lang.Object>	getGenericBindings()
java.util.List<java.lang.Class<?>>	getStaticInjections() Get any static injections requested by the registerable
protected void	requestStaticInjections(java.lang.Class<?>... classes) Request classes to have their static injection honoured
void	run(Injector injector) Run the registerable

Methods inherited from class java.lang.Object

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

Field Detail

injector

protected Injector injector

Constructor Detail

StartupRegisterable

public StartupRegisterable()

Method Detail

execute

protected abstract void execute()

Code to be ran on the registerable's execution.

addBinding

protected <T> void addBinding(java.lang.Class<? super T> interfaze,
                              T instance)

Add a binding to guice with a specific class and instance.

Type Parameters:

T - Object type

Parameters:

interfaze - Class the object will be referenced by

instance - Object that will be binded to the class

addBinding

protected void addBinding(java.lang.Object instance)

Add a binding to guice, reference class is deduced from the instance itself.

Parameters:

instance - Object of the instance to be binded

addBinding

protected <T> void addBinding(com.google.inject.TypeLiteral<? super T> interfaze,
                              T instance)

Add a binding to guice with a specific class & generic, and instance.

Type Parameters:

T - Type parameter belonging to interfaze

Parameters:

interfaze - Class the object will be referenced by

instance - Object that will be binded

addAnnotatedBinding

protected <T> void addAnnotatedBinding(java.lang.Class<? super T> interfaze,
                                       java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                       T instance)

Add a binding to guice that's only injectable when a specific annotation is provided.

Type Parameters:

T - Object type

Parameters:

interfaze - Reference class to be binded to

annotation - Class extending annotation

instance - Instance of the object to be binded.

addAnnotatedBinding

protected <T> void addAnnotatedBinding(java.lang.Class<? super T> interfaze,
                                       java.lang.annotation.Annotation annotation,
                                       T instance)

Add a binding to guice that's only injectable when a specific annotation is provided.

Type Parameters:

T - Object type

Parameters:

interfaze - Reference class to be binded to

annotation - Annotation instance

instance - Instance of the object to be binded

requestStaticInjections

protected void requestStaticInjections(java.lang.Class<?>... classes)

Request classes to have their static injection honoured

Parameters:

classes - Varargs of classes

run

public void run(Injector injector)

Run the registerable

Parameters:

injector - Injector instance that will be provided to the registerable

getBindings

public java.util.Map<java.lang.Class<?>,java.lang.Object> getBindings()

Get a map of bindings to be made

Returns:

Map with Class as key, Object as value

getGenericBindings

public java.util.Map<com.google.inject.TypeLiteral<?>,java.lang.Object> getGenericBindings()

getAnnotatedBindings

public java.util.List<AnnotatedBinding<?>> getAnnotatedBindings()

Get a list of annotated binding objects set by the registerable

Returns:

List of annotatedbinding data objects

getStaticInjections

public java.util.List<java.lang.Class<?>> getStaticInjections()

Get any static injections requested by the registerable

Returns:

List of classes