DependencyScope (robopupu-api API)

java.lang.Object
- com.robopupu.api.dependency.DependencyScope

Direct Known Subclasses:

AppDependencyScope
```
public abstract class DependencyScope
extends java.lang.Object
```
DependencyScope provides an abstract base class for implementing objects that provide and cache a scoped dependencies. An instance of a concrete implementation of DependencyScope is not used directly to access dependencies, but via the static methods of class Dependency (or convenience class D).

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<java.lang.Object>`	`dependants`
`protected java.util.HashMap<java.lang.Class<?>,java.util.ArrayList<java.lang.Object>>`	`dependencies`
`protected DependencyProvider`	`dependencyProvider`
`protected boolean`	`initialized`
`protected DependencyScope`	`mockScope` A reference to an optional overriding `DependencyScope` used providing mock dependencies.
`protected DependencyScope`	`parentScope`

Constructor Summary

Constructors
Modifier Constructor and Description

protected DependencyScope()

Constructors
Modifier	Constructor and Description
`protected`	`DependencyScope()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDependant(java.lang.Object dependant)` Adds the given `Object` as a dependant to this `DependencyScope`.
`protected <T> T`	`cache(java.lang.Class<T> dependencyType, java.lang.Object dependency)` Caches the given requested dependency `Object` using the requested type as a key.
`protected DependencyProvider`	`createDependencyProvider()` This method can be overridden in extending classes to provide a method that explicitly instantiates a `DependencyProvider` for this `DependencyScope`.
`protected <T> T`	`dependency(java.lang.Object dependency)` Caches the requested dependency `Object` before it is returned to a requester.
`protected void`	`dispose()` Disposes this `DependencyScope` to support effective GC and to avoid memory leaks.
`protected <T> void`	`getDependencies(DependencyQuery<T> query, java.lang.Object dependant)` Gets an dependency instance of the specified type.
`protected <T> T`	`getDependency()` This method is meant to be implemented by each concrete implementation of `DependencyScope`.
`protected <T> T`	`getDependency(java.lang.Class<T> dependencyType, java.lang.Object dependant, boolean createNew)` Gets an dependency instance of the specified type.
`protected DependencyProvider`	`getDependencyProvider()` Gets the `DependencyProvider`.
`java.lang.String`	`getId()` Gets the identifier of this `DependencyScope`.
`DependencyScope`	`getMockedScope()` Gets the `DependencyScope` that overrides this `DependencyScope`.
`DependencyScopeOwner`	`getOwner()` Get the `DependencyScopeOwner` that manages the lifecycle this `DependencyScope`.
`DependencyScope`	`getParentScope()` Gets the parent `DependencyScope`.
`boolean`	`hasDependency(java.lang.Class<?> dependencyType)` Tests if an instance of the specified dependency type exists in this `DependencyScope`.
`boolean`	`hasDependency(java.lang.Object dependency)` Tests if given dependency exists in this `DependencyScope`.
`void`	`initialize()` Invoked to initialize this `DependencyScope`.
`boolean`	`isAppScope()` Tests if this `DependencyScope` is a application scoped `DependencyScope`.
`boolean`	`isDisposable()` Tests if this `DependencyScope` can be disposed.
`void`	`onActivated(DependencyScopeOwner owner)` This method is invoked by `Dependency` when this `DependencyScope` is activated for the given `DependencyScopeOwner`.
`void`	`onDeactivated(DependencyScopeOwner owner)` This method is invoked by `Dependency` when this `DependencyScope` is deactivated for the given `DependencyScopeOwner`.
`protected void`	`removeDependant(java.lang.Object dependant)` Removes the given `Object` as a dependant from this `DependencyScope`.
`java.util.List<java.lang.Class<?>>`	`removeDependency(java.lang.Object dependency)` Removes the given dependency from this `DependencyScope`.
`void`	`setMockedScope(DependencyScope scope)` Sets the given `DependencyScope` to override this `DependencyScope`.
`void`	`setOwner(DependencyScopeOwner owner)` Set the `DependencyScopeOwner` that manages the lifecycle this `DependencyScope`.
`void`	`setParentScope(DependencyScope parent)` Sets the parent `DependencyScope`.
`protected boolean`	`type(java.lang.Class<?> dependencyType)` Tests if the specified type represents the requested dependency type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - dependants
```
protected final java.util.ArrayList<java.lang.Object> dependants
```
  - dependencies
```
protected final java.util.HashMap<java.lang.Class<?>,java.util.ArrayList<java.lang.Object>> dependencies
```
  - mockScope
```
protected DependencyScope mockScope
```
    A reference to an optional overriding DependencyScope used providing mock dependencies.
  - parentScope
```
protected DependencyScope parentScope
```
  - dependencyProvider
```
protected DependencyProvider dependencyProvider
```
  - initialized
```
protected boolean initialized
```
- Constructor Detail
  - DependencyScope
```
protected DependencyScope()
```
- Method Detail
  - getDependencyProvider
```
protected DependencyProvider getDependencyProvider()
```
    Gets the DependencyProvider. A DependencyProvider is either code generated by the annotation processor of Fuusio API Compiler or explicitly created by method createDependencyProvider().
    
    Returns:
    
    A DependencyProvider. May return null.
  - getId
```
public java.lang.String getId()
```
    Gets the identifier of this DependencyScope. The default identifier is the canonical class name of the DependencyScope.
    
    Returns:
    
    The identifier as a String.
  - getOwner
```
public final DependencyScopeOwner getOwner()
```
    Get the DependencyScopeOwner that manages the lifecycle this DependencyScope.
    
    Returns:
    
    A DependencyScopeOwner.
  - setOwner
```
public void setOwner(DependencyScopeOwner owner)
```
    Set the DependencyScopeOwner that manages the lifecycle this DependencyScope.
    
    Parameters:
    
    owner - A DependencyScopeOwner.
  - getParentScope
```
public final DependencyScope getParentScope()
```
    Gets the parent DependencyScope.
    
    Returns:
    
    A DependencyScope. May return null if the parent is not set.
  - setParentScope
```
public void setParentScope(DependencyScope parent)
```
    Sets the parent DependencyScope.
    
    Parameters:
    
    parent - A DependencyScope. May be null.
  - getMockedScope
```
public final DependencyScope getMockedScope()
```
    Gets the DependencyScope that overrides this DependencyScope. An overriding DependencyScope can be used for providing mock dependencies for unit tests.
    
    Returns:
    
    A DependencyScope. May return null.
  - setMockedScope
```
public void setMockedScope(DependencyScope scope)
```
    Sets the given DependencyScope to override this DependencyScope. An overriding DependencyScope can be used for providing mock dependencies for unit tests.
    
    Parameters:
    
    scope - A DependencyScope.
  - isDisposable
```
public boolean isDisposable()
```
    Tests if this DependencyScope can be disposed.
    
    Returns:
    
    A boolean value.
  - addDependant
```
public void addDependant(java.lang.Object dependant)
```
    Adds the given Object as a dependant to this DependencyScope.
    
    Parameters:
    
    dependant - An Object.
  - removeDependant
```
protected void removeDependant(java.lang.Object dependant)
```
    Removes the given Object as a dependant from this DependencyScope.
    
    Parameters:
    
    dependant - An Object.
  - type
```
protected final boolean type(java.lang.Class<?> dependencyType)
```
    Tests if the specified type represents the requested dependency type.
    
    Parameters:
    
    dependencyType - A Class specifying the type of the requested dependency.
    
    Returns:
    
    A boolean value.
  - dependency
```
protected final <T> T dependency(java.lang.Object dependency)
```
    Caches the requested dependency Object before it is returned to a requester.
    
    Type Parameters:
    
    T - The generic return type of the cached dependency.
    
    Parameters:
    
    dependency - The requested dependency Object to be cached.
    
    Returns:
    
    The cached dependency Object.
  - cache
```
protected <T> T cache(java.lang.Class<T> dependencyType,
                      java.lang.Object dependency)
```
    Caches the given requested dependency Object using the requested type as a key.
    
    Type Parameters:
    
    T - The generic return type of the cached dependency.
    
    Parameters:
    
    dependencyType - The dependence type as a Class used as a key.
    
    dependency - The requested dependency Object to be cached.
    
    Returns:
    
    The cached dependency Object.
  - getDependency
```
protected <T> T getDependency()
```
    This method is meant to be implemented by each concrete implementation of DependencyScope. The requested dependency instance is returned by the implementation, if it is capable of providing a such instance. The implementation of this method should not delegate the request to any other DependencyScope. If the implementation is not able to cache the requested instance, the design contract is to return null instead.
    
    Type Parameters:
    
    T - A type parameter for casting the requested instance to expected type.
    
    Returns:
    
    The requested dependency instance if is this DependencyScope implementation is capable of providing such instance otherwise null. This default implementation returns null.
  - getDependency
```
protected <T> T getDependency(java.lang.Class<T> dependencyType,
                              java.lang.Object dependant,
                              boolean createNew)
```
    Gets an dependency instance of the specified type. The requested dependency is first searched from the currently active DependencyScope. If a requested instance is not found the search is delegated to parent DependencyScope. As a last attempt, the AppDependencyScope is searched.
    
    Type Parameters:
    
    T - A type parameter for casting the requested instance to expected type.
    
    Parameters:
    
    dependencyType - A Class specifying the type of the requested instance.
    
    dependant - The requesting object. This parameter is required when the requesting dependant is also a requested within the object graph represented by a DependencyScope.
    
    createNew - A boolean parameter specifying if an instance of the requested type should be created using reflection if an instance does not exists already.
    
    Returns:
    
    The returned instance. If null is returned it indicates an error in the implementation of the DependencyScope.
  - getDependencies
```
protected <T> void getDependencies(DependencyQuery<T> query,
                                   java.lang.Object dependant)
```
    Gets an dependency instance of the specified type. The requested dependency is first searched from the currently active DependencyScope. If a requested instance is not found the search is delegated to parent DependencyScope. As a last attempt, the AppDependencyScope is searched.
    
    Type Parameters:
    
    T - A type parameter for casting the requested instance to expected type.
    
    Parameters:
    
    query - A DependencyQuery that defines the context for finding dependencies and a container for storing the found dependencies.
    
    dependant - The requesting object. This parameter is required when the requesting dependant is also a requested within the object graph represented by a DependencyScope.
  - dispose
```
protected void dispose()
```
    Disposes this DependencyScope to support effective GC and to avoid memory leaks.
  - isAppScope
```
public boolean isAppScope()
```
    Tests if this DependencyScope is a application scoped DependencyScope.
    
    Returns:
    
    A boolean,
  - onActivated
```
public void onActivated(DependencyScopeOwner owner)
```
    This method is invoked by Dependency when this DependencyScope is activated for the given DependencyScopeOwner.
    
    Parameters:
    
    owner - A DependencyScopeOwner.
  - onDeactivated
```
public void onDeactivated(DependencyScopeOwner owner)
```
    This method is invoked by Dependency when this DependencyScope is deactivated for the given DependencyScopeOwner.
    
    Parameters:
    
    owner - A DependencyScopeOwner.
  - initialize
```
public void initialize()
```
    Invoked to initialize this DependencyScope.
  - createDependencyProvider
```
protected DependencyProvider createDependencyProvider()
```
    This method can be overridden in extending classes to provide a method that explicitly instantiates a DependencyProvider for this DependencyScope. By default this method returns null. If this method returns a null, then an instance of a DependencyProvider is attempted to instantiate dynamically.
    
    Returns:
    
    A DependencyProvider. The default implementation returns null.
  - removeDependency
```
public java.util.List<java.lang.Class<?>> removeDependency(java.lang.Object dependency)
```
    Removes the given dependency from this DependencyScope.
    
    Parameters:
    
    dependency - The dependency to be removed as an Object.
    
    Returns:
    
    A List of removed dependency types for the given dependency.
  - hasDependency
```
public boolean hasDependency(java.lang.Object dependency)
```
    Tests if given dependency exists in this DependencyScope.
    
    Parameters:
    
    dependency - The dependency as an Object.
  - hasDependency
```
public boolean hasDependency(java.lang.Class<?> dependencyType)
```
    Tests if an instance of the specified dependency type exists in this DependencyScope.
    
    Parameters:
    
    dependencyType - A Class specifying the dependency type.

Class DependencyScope

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dependants

dependencies

mockScope

parentScope

dependencyProvider

initialized

Constructor Detail

DependencyScope

Method Detail

getDependencyProvider

getId

getOwner

setOwner

getParentScope

setParentScope

getMockedScope

setMockedScope

isDisposable

addDependant

removeDependant

type

dependency

cache

getDependency

getDependency

getDependencies

dispose

isAppScope

onActivated

onDeactivated

initialize

createDependencyProvider

removeDependency

hasDependency

hasDependency