rocks.frieler.android.beans

Class BeanConfiguration

java.lang.Object

rocks.frieler.android.beans.BeanConfiguration

Direct Known Subclasses:

BeanDefinition

public abstract class BeanConfiguration
extends java.lang.Object

Abstract super-class to define beans for the context of an application.

BeanConfigurations must provide a public constructor, which takes the Context or no arguments, to be instantiated.

Usage example:

     // 1. extend BeanConfiguration:
     public class MyBeanConfiguration extends BeanConfiguration {

         // 2. declare dependencies to other beans using the require-methods:
         private final BeanDependency<AnotherBean> dependency = requireBean(AnotherBean.class);

         // 3. define beans:
         public void defineBeans(BeansCollector beansCollector) {
             beansCollector.defineBean(new MyBean(dependency.get()));
         }
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeanConfiguration.Readiness

Constructor Summary

Constructors

Constructor and Description
BeanConfiguration()

Method Summary

Modifier and Type	Method and Description
abstract void	defineBeans(BeansCollector beansCollector) Defines beans for the context of this application by calling BeanConfigurationsBeansCollector.defineBean(String, Object) or BeanConfigurationsBeansCollector.defineBean(Object).
protected java.util.List<BeanDependency<?>>	getDependencies() Allows to express BeanDependencys that must be fulfilled for this BeanConfiguration to define its beans.
BeanConfiguration.Readiness	isReadyToDefineBeans(BeansProvider beansProvider) Checks, if this BeanConfiguration is ready to define its beans.
protected <T> BeanDependency<T>	requireBean(java.lang.Class<T> type) Creates and registers a BeanDependency on a bean of the given type.
protected <T> BeanDependency<T>	requireBean(java.lang.String name, java.lang.Class<T> type) Creates and registers a BeanDependency on a bean with the given name and of the given type.
protected <T> BeanDependency<java.util.List<T>>	requireBeans(java.lang.Class<T> type) Creates and registers a BeanDependency on the beans of the given type.
protected <T> BeanDependency<java8.util.Optional<T>>	requireOptionalBean(java.lang.Class<T> type) Creates and registers a BeanDependency on a bean of the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanConfiguration

public BeanConfiguration()

Method Detail

requireBean

protected final <T> BeanDependency<T> requireBean(java.lang.String name,
                                                  java.lang.Class<T> type)

Creates and registers a BeanDependency on a bean with the given name and of the given type.

Type Parameters:

T - the type of the desired bean

Parameters:

name - the name of the desired bean

type - the type of the desired bean

Returns:

the BeanDependency on the desired bean

requireBean

protected final <T> BeanDependency<T> requireBean(java.lang.Class<T> type)

Creates and registers a BeanDependency on a bean of the given type.

Type Parameters:

T - the type of the desired bean

Parameters:

type - the type of the desired bean

Returns:

the BeanDependency on the desired bean

requireOptionalBean

protected final <T> BeanDependency<java8.util.Optional<T>> requireOptionalBean(java.lang.Class<T> type)

Creates and registers a BeanDependency on a bean of the given type.

Type Parameters:

T - the type of the desired bean

Parameters:

type - the type of the desired bean

Returns:

the BeanDependency on the desired bean

requireBeans

protected final <T> BeanDependency<java.util.List<T>> requireBeans(java.lang.Class<T> type)

Creates and registers a BeanDependency on the beans of the given type.

Type Parameters:

T - the type of the desired bean

Parameters:

type - the type of the desired bean

Returns:

the BeanDependency on the desired bean

getDependencies

protected java.util.List<BeanDependency<?>> getDependencies()

Allows to express BeanDependencys that must be fulfilled for this BeanConfiguration to define its beans.

By default this method returns all BeanDependencys registered by the require-methods such as requireBean(String, Class)

Returns:

the BeanDependencys of this BeanConfiguration

isReadyToDefineBeans

public BeanConfiguration.Readiness isReadyToDefineBeans(BeansProvider beansProvider)

Checks, if this BeanConfiguration is ready to define its beans.

Therefor it tries to fulfill all its BeanDependencys returned by getDependencies(). The Readiness is derived from the minimum BeanDependency.Fulfillment of the BeanDependencys. If all are fulfilled the BeanConfiguration is ready, if all are at least unfulfilled but optional the BeanConfiguration should be delayed to wait for additional beans and if at least one BeanDependency is unfulfilled the BeanConfiguration is unready.

Parameters:

beansProvider - the BeansProvider to fulfill BeanDependencys

Returns:

the BeanConfiguration.Readiness of this BeanConfiguration to define its beans

defineBeans

public abstract void defineBeans(BeansCollector beansCollector)

Defines beans for the context of this application by calling BeanConfigurationsBeansCollector.defineBean(String, Object) or BeanConfigurationsBeansCollector.defineBean(Object).

Other beans can by obtained by declaring BeanDependencys to satisfy dependencies of the defined beans through getDependencies(). Hence, the require-methods that register BeanDependencys must not be called inside this method; this must be done earlier. And take care not to create cyclic dependencies between BeanConfigurations which are unresolvable.

This method must not be called before isReadyToDefineBeans(BeansProvider) returned true.

Parameters:

beansCollector - the BeanConfigurationsBeansCollector that collects the beans

See Also:

BeanConfigurationsBeansCollector.defineBean(String, Object), BeanConfigurationsBeansCollector.defineBean(Object)