org.forgerock.guice.core

Class GuiceModuleServiceLoader

java.lang.Object

org.forgerock.guice.core.GuiceModuleServiceLoader

All Implemented Interfaces:

GuiceModuleLoader

public final class GuiceModuleServiceLoader
extends Object
implements GuiceModuleLoader

Will find and load all classes which extend the Guice AbstractModule or PrivateModule class and that are annotated with the provided annotation by using the Java ServiceLoader framework.

To register an AbstractModule with the ServiceLoader framework, create a file named, "com.google.inject.AbstractModule", under META-INF/services with a new line delimited list of the fully qualified names of the subtypes, in your jar/project, to be used to configure the Guice injector.

Any AbstractModule subtypes which are registered with the Java ServiceLoader by are not annotated with the provided annotation will be ignored and will not be included in the returned set of Guice Modules.

Since:

1.0.0

See Also:

ServiceLoader

Method Summary

Modifier and Type	Method and Description
Set<Class<? extends com.google.inject.Module>>	getGuiceModules(Class<? extends Annotation> moduleAnnotation) Finds and loads all the Guice modules that will be used to configure the Guice injector instance.

Methods inherited from class java.lang.Object

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

Method Detail

getGuiceModules

public Set<Class<? extends com.google.inject.Module>> getGuiceModules(Class<? extends Annotation> moduleAnnotation)

Finds and loads all the Guice modules that will be used to configure the Guice injector instance.

Specified by:

getGuiceModules in interface GuiceModuleLoader

Parameters:

moduleAnnotation - The Annotation that all modules MUST be annotated with.

Returns:

A Set of Guice modules.