org.grouplens.grapht

Class BindingFunctionBuilder

java.lang.Object

org.grouplens.grapht.BindingFunctionBuilder

All Implemented Interfaces:

Cloneable

public class BindingFunctionBuilder
extends Object
implements Cloneable

BindingFunctionBuilder provides a convenient access to the fluent API and converts calls to Context and Binding methods into multiple BindingFunctions.

Author:

GroupLens Research

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BindingFunctionBuilder.RuleSet BindingFunctionBuilder generates three binding functions at separate priorities.

Constructor Summary

Constructors

Constructor and Description
BindingFunctionBuilder() Create a new InjectorConfigurationBuilder that automatically generates bind rules for super and intermediate types.
BindingFunctionBuilder(boolean generateRules) Create a new InjectorConfigurationBuilder.

Method Summary

Modifier and Type	Method and Description
void	addDefaultExclusion(Class<?> type) Add a type to be excluded from when generating bind rules.
void	applyModule(Module module) Run the module's bind() method on the root context of this builder.
BindingFunction	build(BindingFunctionBuilder.RuleSet set) Return the built BindingFunction for the given RuleSet.
BindingFunctionBuilder	clone()
boolean	getGenerateRules()
Context	getRootContext()
void	removeDefaultExclusion(Class<?> type) Remove a type that is currently being excluded.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingFunctionBuilder

public BindingFunctionBuilder()

Create a new InjectorConfigurationBuilder that automatically generates bind rules for super and intermediate types.

BindingFunctionBuilder

public BindingFunctionBuilder(boolean generateRules)

Create a new InjectorConfigurationBuilder. If generateRules is true, bind rules for super and intermediate types are generated. If it is false, only one bind rule is created per binding.

Parameters:

generateRules - True if additional bind rules should be generated

Method Detail

clone

public BindingFunctionBuilder clone()

Overrides:

clone in class Object

getGenerateRules

public boolean getGenerateRules()

Returns:

True if bind rules for super and intermediate types should be generated

getRootContext

public Context getRootContext()

Returns:

The root context managed by this builder

applyModule

public void applyModule(Module module)

Run the module's bind() method on the root context of this builder.

Parameters:

module - The module to apply

addDefaultExclusion

public void addDefaultExclusion(Class<?> type)

Add a type to be excluded from when generating bind rules. This does not invalidate bindings that bind directly to this type.

Parameters:

type - The type to exclude

Throws:

NullPointerException - if type is null

removeDefaultExclusion

public void removeDefaultExclusion(Class<?> type)

Remove a type that is currently being excluded.

Parameters:

type - The type that should no longer be excluded

Throws:

NullPointerException - if type is null

See Also:

addDefaultExclusion(Class)

build

public BindingFunction build(BindingFunctionBuilder.RuleSet set)

Return the built BindingFunction for the given RuleSet.

Parameters:

set -

Returns: