org.forgerock.guice.core

Enum InjectorConfiguration

java.lang.Object

java.lang.Enum<InjectorConfiguration>

org.forgerock.guice.core.InjectorConfiguration

All Implemented Interfaces:

Serializable, Comparable<InjectorConfiguration>

public enum InjectorConfiguration
extends Enum<InjectorConfiguration>

A thread-safe singleton holding the configuration information on how the Guice framework finds Guice Modules to configure the Guice Injector instance.

This singleton holds the Module annotation that all Guice Modules, that should be used to configure the injector, MUST be annotated with. And the implementation of the GuiceModuleLoader that will be used to find and load the module classes.

By default the module annotation is configured to be GuiceModule and the GuiceModuleLoader implementation is configured to be GuiceModuleServiceLoader. These configurations can be changed by calling, setModuleAnnotation(Class) and setGuiceModuleLoader(GuiceModuleLoader),respectively.

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The Singleton instance of the InjectorConfiguration.

Method Summary

Modifier and Type	Method and Description
static void	setGuiceModuleLoader(GuiceModuleLoader guiceModuleLoader) Sets the GuiceModuleLoader implementation that will be used to find and load module classes.
static void	setModuleAnnotation(Class<? extends Annotation> moduleAnnotation) Sets the module annotation that all modules MUST be annotated with.
static void	setStage(com.google.inject.Stage stage) Sets the Stage that the injector should run in.
static InjectorConfiguration	valueOf(String name) Returns the enum constant of this type with the specified name.
static InjectorConfiguration[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final InjectorConfiguration INSTANCE

The Singleton instance of the InjectorConfiguration.

Method Detail

values

public static InjectorConfiguration[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InjectorConfiguration c : InjectorConfiguration.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InjectorConfiguration valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

setModuleAnnotation

public static void setModuleAnnotation(Class<? extends Annotation> moduleAnnotation)

Sets the module annotation that all modules MUST be annotated with.

Parameters:

moduleAnnotation - The module annotation.

setGuiceModuleLoader

public static void setGuiceModuleLoader(GuiceModuleLoader guiceModuleLoader)

Sets the GuiceModuleLoader implementation that will be used to find and load module classes.

Parameters:

guiceModuleLoader - The GuiceModuleLoader implementation.

setStage

public static void setStage(com.google.inject.Stage stage)

Sets the Stage that the injector should run in. See Stage for available stages and their differences.

Parameters:

stage - The injector stage.