org.grouplens.grapht.solver

Class DependencySolverBuilder

java.lang.Object

org.grouplens.grapht.solver.DependencySolverBuilder

public class DependencySolverBuilder
extends Object

A builder for DependencySolvers.

Since:

0.6

Author:

GroupLens Research

See Also:

DependencySolver.newBuilder()

Constructor Summary

Constructors

Constructor and Description
DependencySolverBuilder()

Method Summary

Modifier and Type	Method and Description
DependencySolverBuilder	addBindingFunction(BindingFunction func) Add a binding function to the dependency solver.
DependencySolverBuilder	addBindingFunction(BindingFunction func, boolean canTriggerRewrite) Add a binding function to the dependency solver.
DependencySolverBuilder	addBindingFunctions(BindingFunction... funcs) Add multiple binding function to the dependency solver.
DependencySolverBuilder	addBindingFunctions(Iterable<BindingFunction> funcs) Add multiple binding function to the dependency solver.
DependencySolver	build() Build a dependency solver.
List<BindingFunction>	getBindingFunctions() Get the current list of binding functions.
CachePolicy	getDefaultPolicy() Get the current default policy.
int	getMaxDepth() Get the maximum depth.
List<BindingFunction>	getTriggerFunctions() Get the current list of trigger binding functions.
DependencySolverBuilder	setDefaultPolicy(CachePolicy policy) Set the default policy for the solver.
DependencySolverBuilder	setMaxDepth(int depth) Set the maximum object graph depth, for cycle detection.

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencySolverBuilder

public DependencySolverBuilder()

Method Detail

getBindingFunctions

public List<BindingFunction> getBindingFunctions()

Get the current list of binding functions.

Returns:

The current list of binding functions.

getTriggerFunctions

public List<BindingFunction> getTriggerFunctions()

Get the current list of trigger binding functions. These are the binding functions for which canTriggerRewrite is true in addBindingFunction(BindingFunction,boolean).

Returns:

The current list of trigger binding functions.

addBindingFunction

public DependencySolverBuilder addBindingFunction(@Nonnull
                                                  BindingFunction func)

Add a binding function to the dependency solver.

Parameters:

func - The binding function.

Returns:

The builder (for chaining).

addBindingFunction

public DependencySolverBuilder addBindingFunction(@Nonnull
                                                  BindingFunction func,
                                                  boolean canTriggerRewrite)

Add a binding function to the dependency solver.

Parameters:

func - The binding function.

canTriggerRewrite - Controls whether this binding function can activate re-resolution when doing a graph rewrite. If true (the value passed by all other binding function adders), this binding function returning a binding will cause a graph rewrite; if false, it will be ignored during rewrites until the rewrite has been triggered by some other binding function. Register the default binding function with false here to keep default bindings from triggering rewrites.

Returns:

The builder (for chaining).

addBindingFunctions

public DependencySolverBuilder addBindingFunctions(@Nonnull
                                                   BindingFunction... funcs)

Add multiple binding function to the dependency solver.

Parameters:

funcs - The binding functions.

Returns:

The builder (for chaining).

addBindingFunctions

public DependencySolverBuilder addBindingFunctions(@Nonnull
                                                   Iterable<BindingFunction> funcs)

Add multiple binding function to the dependency solver.

Parameters:

funcs - The binding functions.

Returns:

The builder (for chaining).

getDefaultPolicy

public CachePolicy getDefaultPolicy()

Get the current default policy.

Returns:

The builder's current default policy.

setDefaultPolicy

public DependencySolverBuilder setDefaultPolicy(CachePolicy policy)

Set the default policy for the solver. This policy will be used when a satisfaction has a policy of CachePolicy.NO_PREFERENCE. The default is CachePolicy.NO_PREFERENCE, so the injector will make final caching decisions.

Parameters:

policy - The default policy for the solver.

Returns:

The builder (for chaining).

getMaxDepth

public int getMaxDepth()

Get the maximum depth.

Returns:

The maximum object graph depth.

setMaxDepth

public DependencySolverBuilder setMaxDepth(int depth)

Set the maximum object graph depth, for cycle detection.

Parameters:

depth - The maximum object graph depth that the solver is allowed to produce.

Returns:

The builder (for chaining).

build

public DependencySolver build()

Build a dependency solver.

Returns:

The dependency solver.