org.osgl.inject

Class Genie.Binder<T>

java.lang.Object

org.osgl.inject.Genie.Binder<T>

Type Parameters:

T - A generic type of binding object

Enclosing class:

Genie

public static class Genie.Binder<T>
extends Object

A Binder is used in module configure method to define a custom binding.

Constructor Summary

Constructors

Constructor and Description
Binder(Class<T> type) Create a Binder for specified class

Method Summary

Modifier and Type	Method and Description
Genie.Binder<T>	doNotFireEvent() Turn off the forceFireEvent flag.
Genie.Binder<T>	forceFireEvent() Turn on forceFireEvent flag.
Genie.Binder<T>	in(Class<? extends Annotation> scope) Constraint the binder with a scope annotation class.
Genie.Binder<T>	named(String name) Constraint the binding with a name.
Genie.Binder<T>	qualifiedWith(Annotation... qualifiers) Add qualifier annotation constraints to this binder
Genie.Binder<T>	qualifiedWith(Class<? extends Annotation>... qualifiers) Add qualifier annotation constraints to this binder
void	register(Genie genie) Register this binder to Genie
Genie.Binder<T>	to(Class<? extends T> impl) Bind this Binder to a specific implementation.
Genie.Binder<T>	to(Constructor<? extends T> constructor) Bind this binder to a constructor
Genie.Binder<T>	to(javax.inject.Provider<? extends T> provider) Bind this Binder to a provider.
Genie.Binder<T>	to(T instance) Bind this Binder to a specific instance
Genie.Binder<T>	toConstructor(Class<? extends T> implement, Class<?>... args) Bind this instance to a constructor specified by class and constructor arguments.
Genie.Binder<T>	withAnnotation(Annotation... annotations) Deprecated.
Genie.Binder<T>	withAnnotation(Class<? extends Annotation>... annotations) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Binder

public Binder(Class<T> type)

Create a Binder for specified class

Parameters:

type - the type to be bound

Method Detail

to

public Genie.Binder<T> to(Class<? extends T> impl)

Bind this Binder to a specific implementation.

If there is another binding already specified then it will throw out an IllegalStateException

Parameters:

impl - the implementation class

Returns:

this binder instance

Throws:

IllegalStateException - if another binding exists

to

public Genie.Binder<T> to(T instance)

Bind this Binder to a specific instance

If there is another binding already specified then it will throw out an IllegalStateException

Parameters:

instance - the instance to which the Binder is bound

Returns:

this binder instance

Throws:

IllegalStateException - if another binding exists

to

public Genie.Binder<T> to(javax.inject.Provider<? extends T> provider)

Bind this Binder to a provider.

If there is another binding already specified then it will throw out an IllegalStateException

Parameters:

provider - the provider that provides the instance to which this binder is bound

Returns:

this binder instance

Throws:

IllegalStateException - if another binding exists

to

public Genie.Binder<T> to(Constructor<? extends T> constructor)

Bind this binder to a constructor

If there is another binding already specified then it will throw out an IllegalStateException

Parameters:

constructor - the constructor that generate the instance to which this binder is bound

Returns:

this binder instance

Throws:

IllegalStateException - if another binding exists

toConstructor

public Genie.Binder<T> toConstructor(Class<? extends T> implement,
                                     Class<?>... args)

Bind this instance to a constructor specified by class and constructor arguments.

This is a convenient method for constructor binding as the developer does not need to provides a Constructor instance

If no constructor found with the class and argument types then an InjectException will be thrown out

If there is another binding already specified then it will throw out an IllegalStateException

Parameters:

implement - the class of the target instance

args - the constructor argument types

Returns:

this binder instance

Throws:

InjectException - if no constructor found by the spec

IllegalStateException - if another binding exists

named

public Genie.Binder<T> named(String name)

Constraint the binding with a name.

A name is usually specified via Named annotation when declaring an injection. When genie looking for a provider for a named injection, it will check if the supplied binding matches the name specified.

If there is a name already registered it will throw out an IllegalArgumentException

Parameters:

name - the name of the binding

Returns:

this Binder instance

Throws:

IllegalArgumentException - if there is name already registered

in

public Genie.Binder<T> in(Class<? extends Annotation> scope)

Constraint the binder with a scope annotation class.

Once the constraint is added to this binder the binding will search for candidates within the scope constraint only

The scope annotation class must be tagged with Scope annotation. Otherwise a InjectException will be thrown out.

Parameters:

scope - the scope annotation class

Returns:

this binder instance

Throws:

InjectException - if the scope class is not annotated with Scope

IllegalStateException - if there is already a scope annotation constraint put on this binder

See Also:

Scope

withAnnotation

@Deprecated
public Genie.Binder<T> withAnnotation(Class<? extends Annotation>... annotations)

Deprecated.

Add annotation constraints to this binder.

Usually the annotation specified in the parameter should be a valid qualifiers

This method is deprecated. Please use qualifiedWith(Class[]) instead

Parameters:

annotations - an array of annotation classes

Returns:

this binder instance

See Also:

Qualifier

withAnnotation

@Deprecated
public Genie.Binder<T> withAnnotation(Annotation... annotations)

Deprecated.

Add annotation constraints to this binder.

Usually the type of the annotation specified in the parameter should be a valid qualifiers

This method is deprecated. Please use qualifiedWith(Annotation...) instead

Parameters:

annotations - an array of annotation classes

Returns:

this binder instance

See Also:

Qualifier

qualifiedWith

public Genie.Binder<T> qualifiedWith(Class<? extends Annotation>... qualifiers)

Add qualifier annotation constraints to this binder

Each qualifier annotation type must be tagged with Qualifier annotation. Otherwise an InjectException will be thrown out

Parameters:

qualifiers - an array of qualifier annotation types

Returns:

this binder instance

Throws:

InjectException - if the any qualifier class is not tagged with Qualifier

See Also:

Qualifier

qualifiedWith

public Genie.Binder<T> qualifiedWith(Annotation... qualifiers)

Add qualifier annotation constraints to this binder

The type of each qualifier annotation must be tagged with Qualifier annotation. Otherwise an InjectException will be thrown out

Parameters:

qualifiers - an array of qualifier annotations

Returns:

this binder instance

Throws:

InjectException - if the any qualifier’s class is not tagged with Qualifier

See Also:

Qualifier

forceFireEvent

public Genie.Binder<T> forceFireEvent()

Turn on forceFireEvent flag.

Once force fire event flag is turned on, when it calls register(Genie) method the Genie.fireProviderRegisteredEvent(Class) method will be called

Returns:

this binder instance

doNotFireEvent

public Genie.Binder<T> doNotFireEvent()

Turn off the forceFireEvent flag.

If this flag is turned off, no Genie.fireProviderRegisteredEvent(Class) call will happen upon register(Genie) method is called

Returns:

this binder instance

register

public void register(Genie genie)

Register this binder to Genie

Parameters:

genie - the dependency injector