Interface BindingBuilder<T>

Type Parameters:

T - the type of Object that is injectable

All Known Implementing Classes:

AbstractBindingBuilder

public interface BindingBuilder<T>

A fluent builder for Bindings.

Since:

Oct-2024

Author:

brian.oliver

Method Summary

Modifier and Type	Method	Description
BindingBuilder<T>	as(String name)	Configures the BindingBuilder to create Bindings injectable with Dependencys that require named values, the name being specified using the Named annotation.
default void	asAllInterfaces()	Registers a Binding of the bound value to each non-java.* interface in its type hierarchy.
default void	asAllInterfaces(Predicate<Class<?>> filter)	Registers a Binding of the bound value to each interface in its type hierarchy that matches the supplied Predicate.
Binding<T>	to(Class<? extends T> bindingValueClass)	Creates a Binding that uses an instance of the specified concrete Class to construct values for injection.
Binding<T>	to(Supplier<T> supplier)	Creates a Binding that uses the specified Supplier for acquiring values for injection.
Binding<T>	to(T value)	Creates a Binding that uses the specified value for injection.
default Binding<T>	toOverriding(Class<? extends T> implementationClass)	Replaces an existing Binding for this type with an instance of the specified concrete Class, or registers a new Binding if none exists.
default Binding<T>	toOverriding(Supplier<T> supplier)	Replaces an existing Binding for this type with the specified Supplier, or registers a new Binding if none exists.
default Binding<T>	toOverriding(T value)	Replaces an existing Binding for this type with the specified value, or registers a new Binding if none exists.
BindingBuilder<T>	with(build.codemodel.foundation.usage.AnnotationTypeUsage qualifier)	Configures the BindingBuilder to create Bindings requiring the specified AnnotationTypeUsage.
BindingBuilder<T>	with(Annotation annotation)	Configures the BindingBuilder to create Bindings requiring the specified Qualifier Annotation.
BindingBuilder<T>	with(Class<? extends Annotation> annotationClass)	Configures the BindingBuilder to create Bindings requiring the specified Marker Qualifier Annotation.

Method Details

to

Binding<T> to(T value)

Creates a Binding that uses the specified value for injection.

Parameters:

value - the value

Returns:

the newly created Binding

to

Binding<T> to(Class<? extends T> bindingValueClass)

Creates a Binding that uses an instance of the specified concrete Class to construct values for injection.

Parameters:

bindingValueClass - the Class of value to bind

Returns:

the newly created Binding

to

Binding<T> to(Supplier<T> supplier)

Creates a Binding that uses the specified Supplier for acquiring values for injection.

Parameters:

supplier - the Supplier

Returns:

a newly created Binding

as

BindingBuilder<T> as(String name)

Configures the BindingBuilder to create Bindings injectable with Dependencys that require named values, the name being specified using the Named annotation.

Parameters:

name - the name

Returns:

this BindingBuilder to permit fluent-style method invocation

with

BindingBuilder<T> with(Class<? extends Annotation> annotationClass)

Configures the BindingBuilder to create Bindings requiring the specified Marker Qualifier Annotation.

Parameters:

annotationClass - the Class of Annotation

Returns:

this BindingBuilder to permit fluent-style method invocation

with

BindingBuilder<T> with(Annotation annotation)

Configures the BindingBuilder to create Bindings requiring the specified Qualifier Annotation.

Parameters:

annotation - the Annotation

Returns:

this BindingBuilder to permit fluent-style method invocation

with

BindingBuilder<T> with(build.codemodel.foundation.usage.AnnotationTypeUsage qualifier)

Configures the BindingBuilder to create Bindings requiring the specified AnnotationTypeUsage.

Parameters:

qualifier - the AnnotationTypeUsage

Returns:

this BindingBuilder to permit fluent-style method invocation

toOverriding

default Binding<T> toOverriding(T value)

Replaces an existing Binding for this type with the specified value, or registers a new Binding if none exists. Unlike to(Object), this does not throw BindingAlreadyExistsException when a binding is already registered.

Parameters:

value - the value

Returns:

the newly registered Binding

toOverriding

default Binding<T> toOverriding(Class<? extends T> implementationClass)

Replaces an existing Binding for this type with an instance of the specified concrete Class, or registers a new Binding if none exists.

Parameters:

implementationClass - the concrete Class to bind

Returns:

the newly registered Binding

toOverriding

default Binding<T> toOverriding(Supplier<T> supplier)

Replaces an existing Binding for this type with the specified Supplier, or registers a new Binding if none exists.

Parameters:

supplier - the Supplier

Returns:

the newly registered Binding

asAllInterfaces

default void asAllInterfaces()

Registers a Binding of the bound value to each non-java.* interface in its type hierarchy. Equivalent to calling asAllInterfaces(Predicate) with a filter that excludes interfaces whose package name starts with "java.".

Example:

context.bind(myService).asAllInterfaces();
// equivalent to registering bind(ServiceInterface.class).to(myService) for every user interface

Throws:

UnsupportedOperationException - if called on a builder that was not created via Context.bind(Object)

asAllInterfaces

default void asAllInterfaces(Predicate<Class<?>> filter)

Registers a Binding of the bound value to each interface in its type hierarchy that matches the supplied Predicate.

Parameters:

filter - a Predicate applied to each interface Class; only matching interfaces are bound

Throws:

UnsupportedOperationException - if called on a builder that was not created via Context.bind(Object)