rocks.frieler.android.beans

Class OptionalSingleBeanDependency<T>

java.lang.Object

rocks.frieler.android.beans.OptionalSingleBeanDependency<T>

Type Parameters:

T - the bean-type

All Implemented Interfaces:

BeanDependency<java8.util.Optional<T>>

public class OptionalSingleBeanDependency<T>
extends java.lang.Object
implements BeanDependency<java8.util.Optional<T>>

BeanDependency to express an optional dependency on a single bean.

This kind of dependency always indicates to be fulfilled and will try to provide the wanted by obtaining it from the BeansProvider as late as possible.

Nested Class Summary

Nested classes/interfaces inherited from interface rocks.frieler.android.beans.BeanDependency

BeanDependency.Fulfillment

Constructor Summary

Constructors

Constructor and Description
OptionalSingleBeanDependency(java.lang.Class<? extends T> type) Creates a new optional BeanDependency to a bean of the given type.
OptionalSingleBeanDependency(java.lang.String name, java.lang.Class<? extends T> type) Creates a new optional BeanDependency to a bean with the given name and of the given type.

Method Summary

Modifier and Type	Method and Description
BeanDependency.Fulfillment	fulfill(BeansProvider beansProvider) Tries to fulfill this BeanDependency with beans from the given BeansProvider and returns the state of fulfillment.
java8.util.Optional<T>	get() Returns the target of this BeanDependency after it was fulfilled.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalSingleBeanDependency

public OptionalSingleBeanDependency(java.lang.Class<? extends T> type)

Creates a new optional BeanDependency to a bean of the given type.

Parameters:

type - the type of the bean

OptionalSingleBeanDependency

public OptionalSingleBeanDependency(java.lang.String name,
                                    java.lang.Class<? extends T> type)

Creates a new optional BeanDependency to a bean with the given name and of the given type.

Parameters:

name - the name of the bean

type - the type of the bean

Method Detail

fulfill

public BeanDependency.Fulfillment fulfill(BeansProvider beansProvider)

Tries to fulfill this BeanDependency with beans from the given BeansProvider and returns the state of fulfillment.

As long as there is no suitable bean for this dependency is available, this dependency is Fulfillment#UNFULFILLED_OPTIONAL. After a suitable bean could be obtained, this dependency is Fulfillment#FULFILLED and the BeansProvider will no linger be queried.

Specified by:

fulfill in interface BeanDependency<java8.util.Optional<T>>

Parameters:

beansProvider - the BeansProvider to obtain beans from

Returns:

the BeanDependency.Fulfillment

get

public java8.util.Optional<T> get()

Description copied from interface: BeanDependency

Returns the target of this BeanDependency after it was fulfilled.

Specified by:

get in interface BeanDependency<java8.util.Optional<T>>

Returns:

the target of this BeanDependency