com.robopupu.api.dependency

Class Dependency

java.lang.Object

com.robopupu.api.dependency.Dependency

Direct Known Subclasses:

D

public class Dependency
extends java.lang.Object

Dependency implements a manager that is used to manage DependencyScope instances. It provides a static API with methods for activating and deactivating DependencyScope instances.

Constructor Summary

Constructors

Constructor and Description
Dependency()

Method Summary

Modifier and Type	Method and Description
static void	activateScope(DependencyScopeOwner owner) Activates a DependencyScope for the given DependencyScopeOwner.
static void	activateScope(DependencyScopeOwner owner, DependencyScope scope) Activates the given DependencyScope for the given DependencyScopeOwner.
static void	addDependant(java.lang.Object dependant) Adds the given Object as an dependant to currently active scope - if one exists.
static DependencyScope	addScope(DependencyScopeOwner owner) Adds the DependencyScope owner by the given DependencyScopeOwner to the HashMap of the current DependencyScopes.
static void	deactivateScope(DependencyScopeOwner owner) Deactivates a DependencyScope managed by the given DependencyScopeOwner.
static void	disposeScope(DependencyScopeOwner owner) Disposes the DependencyScope of the given DependencyScopeOwner.
static void	disposeScopes() Invoked to dispose all the registered DependencyScopes.
static <T> T	get(java.lang.Class<? extends DependencyScope> scopeClass, java.lang.Class<T> dependencyType) Gets a dependency of the specified type.
static <T> T	get(java.lang.Class<? extends DependencyScope> scopeClass, java.lang.Class<T> dependencyType, java.lang.Object dependant) Gets a dependency of the specified type.
static <T> T	get(java.lang.Class<T> dependencyType) Gets a dependency of the specified type.
static <T> T	get(java.lang.Class<T> dependencyType, java.lang.Object dependant) Gets a dependency of the specified type.
static <T> T	get(DependencyScope scope, java.lang.Class<T> dependencyType) Gets a dependency of the specified type.
static <T> T	get(DependencyScope scope, java.lang.Class<T> dependencyType, java.lang.Object dependant) Gets a dependency of the specified type.
static DependencyScope	getActiveScope() Gets the DependencyScope that is set to be currently the active one.
static <T> java.util.Collection<T>	getAll(java.lang.Class<? extends DependencyScope> scopeType, java.lang.Class<T> dependencyType) Gets all dependency of the specified type.
static <T> java.util.Collection<T>	getAll(java.lang.Class<? extends DependencyScope> scopeClass, java.lang.Class<T> dependencyType, java.lang.Object dependant) Gets all dependencies of the specified type.
static <T> java.util.Collection<T>	getAll(java.lang.Class<T> dependencyType) Gets all dependencies of the specified type.
static <T> java.util.Collection<T>	getAll(java.lang.Class<T> dependencyType, java.lang.Object dependant) Gets all dependencies of the specified type.
static <T> java.util.Collection<T>	getAll(DependencyScope scope, java.lang.Class<T> dependencyType) Gets all dependencies of the specified type.
static <T> java.util.Collection<T>	getAll(DependencyScope scope, java.lang.Class<T> dependencyType, java.lang.Object dependant) Gets all dependencies of the specified type.
static DependencyScope	getAppScope() Gets the application level DependencyScope.
static <T extends DependencyScope> T	getScope(java.lang.Class<? extends DependencyScope> scopeClass) Gets a specified DependencyScope.
static <T extends DependencyScope> T	getScope(java.lang.Class<? extends DependencyScope> scopeClass, boolean createInstance) Gets a specified DependencyScope.
static <T extends DependencyScope> T	getScope(DependencyScopeOwner owner, boolean createInstance) Gets a DependencyScope managed by the given DependencyScopeOwner.
static <T extends DependencyScope> T	getScope(java.lang.String scopeClassName, boolean createInstance) Gets a DependencyScope specified by the given canonical class name.
static void	removeDependant(java.lang.Object dependant) Removes the given Object as an dependant from currently active scope - if one exists.
static void	resetActiveScope() This method resets the currently active DependencyScope to null.
protected static void	resetAppScope() This method resets the application level DependencyScope to null.
static void	setAppScope(DependencyScope appScope) Sets the application level DependencyScope.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dependency

public Dependency()

Method Detail

addScope

public static DependencyScope addScope(DependencyScopeOwner owner)

Adds the DependencyScope owner by the given DependencyScopeOwner to the HashMap of the current DependencyScopes.

Parameters:

owner - A DependencyScopeOwner

Returns:

A DependencyScope.

getScope

public static <T extends DependencyScope> T getScope(DependencyScopeOwner owner,
                                                     boolean createInstance)

Gets a DependencyScope managed by the given DependencyScopeOwner.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

owner - A DependencyScopeOwner.

createInstance - A boolean flag specifying if the requested DependencyScope is attempted to be created via reflection in case the requested DependencyScope is not registered yet.

Returns:

A DependencyScope. May return null.

getScope

public static <T extends DependencyScope> T getScope(java.lang.String scopeClassName,
                                                     boolean createInstance)

Gets a DependencyScope specified by the given canonical class name.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scopeClassName - The canonical name of the DependencyScope.

createInstance - A boolean flag specifying if the requested DependencyScope is attempted to be created via reflection in case the requested DependencyScope is not registered yet.

Returns:

A DependencyScope. May return null.

getScope

public static <T extends DependencyScope> T getScope(java.lang.Class<? extends DependencyScope> scopeClass)

Gets a specified DependencyScope.

Parameters:

scopeClass - A Class specifying DependencyScope.

Returns:

The requested DependencyScope. If null is returned, it indicates an error in an DependencyScope implementation.

getScope

public static <T extends DependencyScope> T getScope(java.lang.Class<? extends DependencyScope> scopeClass,
                                                     boolean createInstance)

Gets a specified DependencyScope.

Parameters:

scopeClass - A Class specifying DependencyScope.

createInstance - A boolean flag specifying if the requested DependencyScope is attempted to be created via reflection in case the requested DependencyScope is not registered yet.

Returns:

The requested DependencyScope. If null is returned, it indicates an error in an DependencyScope implementation.

getAppScope

public static DependencyScope getAppScope()

Gets the application level DependencyScope.

Returns:

A DependencyScope.

getActiveScope

public static DependencyScope getActiveScope()

Gets the DependencyScope that is set to be currently the active one. Note that only one DependencyScope can be active at any given. If no DependencyScope is set to be active, the application level DependencyScope is returned.

Returns:

A DependencyScope. May not return null.

setAppScope

public static void setAppScope(DependencyScope appScope)

Sets the application level DependencyScope.

Parameters:

appScope - A DependencyScope.

activateScope

public static void activateScope(DependencyScopeOwner owner)

Activates a DependencyScope for the given DependencyScopeOwner. The active DependencyScope is used for resolving dependencies. Setting the currently active DependencyScope is not thread safe. Therefore this method can be invoked only from the Main UI thread.

Parameters:

owner - A DependencyScopeOwner.

activateScope

public static void activateScope(DependencyScopeOwner owner,
                                 DependencyScope scope)

Activates the given DependencyScope for the given DependencyScopeOwner. The active DependencyScope is used for resolving dependencies. Setting the currently active DependencyScope is not thread safe. Therefore this method can be invoked only from the Main UI thread. This method is suitable to be used when the actual instance

Parameters:

owner - A DependencyScopeOwner.

scope - A DependencyScope.

deactivateScope

public static void deactivateScope(DependencyScopeOwner owner)

Deactivates a DependencyScope managed by the given DependencyScopeOwner. When a DependencyScope is deactivated it is also disposed if disposing is allowed for the deactivated DependencyScope.

Parameters:

owner - A DependencyScopeOwner.

disposeScope

public static void disposeScope(DependencyScopeOwner owner)

Disposes the DependencyScope of the given DependencyScopeOwner.

Parameters:

owner - A DependencyScopeOwner.

disposeScopes

public static void disposeScopes()

Invoked to dispose all the registered DependencyScopes.

get

public static <T> T get(java.lang.Class<T> dependencyType)

Gets a dependency of the specified type. The dependency is requested from the currently active DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

dependencyType - A Class specifying the type of the requested dependency.

Returns:

The requested dependency. If null is returned, it indicates an error in an DependencyScope implementation.

get

public static <T> T get(java.lang.Class<? extends DependencyScope> scopeClass,
                        java.lang.Class<T> dependencyType)

Gets a dependency of the specified type. The dependency is requested from the given DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scopeClass - A Class specifying DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

Returns:

The requested dependency. If null is returned, it indicates an error in an DependencyScope implementation.

get

public static <T> T get(java.lang.Class<? extends DependencyScope> scopeClass,
                        java.lang.Class<T> dependencyType,
                        java.lang.Object dependant)

Gets a dependency of the specified type. The dependency is requested from the specified DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scopeClass - A Class specifying DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

dependant - The object requesting the requested. This parameter is required when the requesting object is also a requested within the object graph represented by the active Dependency.

Returns:

The requested dependency. If null is returned, it indicates an error in an DependencyScope implementation.

get

public static <T> T get(DependencyScope scope,
                        java.lang.Class<T> dependencyType)

Gets a dependency of the specified type. The dependency is requested from the given DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scope - A DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

Returns:

The requested dependency. If null is returned, it indicates an error in an DependencyScope implementation.

get

public static <T> T get(java.lang.Class<T> dependencyType,
                        java.lang.Object dependant)

Gets a dependency of the specified type. The dependency is requested from the currently active DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

dependencyType - A Class specifying the type of the requested dependency.

dependant - The object requesting the requested. This parameter is required when the requesting object is also a requested within the object graph represented by the active Dependency.

Returns:

The requested dependency. If null is returned, it indicates an error in an DependencyScope implementation.

get

public static <T> T get(DependencyScope scope,
                        java.lang.Class<T> dependencyType,
                        java.lang.Object dependant)

Gets a dependency of the specified type. The dependency is requested from the currently active DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scope - A DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

dependant - The object requesting the requested. This parameter is required when the requesting object is also a requested within the object graph represented by the active Dependency.

Returns:

The requested dependency. If null is returned, it indicates an error in an DependencyScope implementation.

getAll

public static <T> java.util.Collection<T> getAll(java.lang.Class<T> dependencyType)

Gets all dependencies of the specified type. The dependencies are requested from the currently active DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

dependencyType - A Class specifying the type of the requested dependency.

Returns:

A Collection containing the found dependencies. If an empty Collection is returned, it indicates an error in an DependencyScope implementation or configuration.

getAll

public static <T> java.util.Collection<T> getAll(java.lang.Class<? extends DependencyScope> scopeType,
                                                 java.lang.Class<T> dependencyType)

Gets all dependency of the specified type. The dependencies are requested from the given DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scopeType - A Class specifying DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

Returns:

A Collection containing the found dependencies. If an empty Collection is returned, it indicates an error in an DependencyScope implementation or configuration.

getAll

public static <T> java.util.Collection<T> getAll(java.lang.Class<? extends DependencyScope> scopeClass,
                                                 java.lang.Class<T> dependencyType,
                                                 java.lang.Object dependant)

Gets all dependencies of the specified type. The dependencies are requested from the specified DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scopeClass - A Class specifying DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

dependant - The object requesting the requested. This parameter is required when the requesting object is also a requested within the object graph represented by the active Dependency.

Returns:

A Collection containing the found dependencies. If an empty Collection is returned, it indicates an error in an DependencyScope implementation or configuration.

getAll

public static <T> java.util.Collection<T> getAll(DependencyScope scope,
                                                 java.lang.Class<T> dependencyType)

Gets all dependencies of the specified type. The dependencies are requested from the given DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scope - A DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

Returns:

A Collection containing the found dependencies. If an empty Collection is returned, it indicates an error in an DependencyScope implementation or configuration.

getAll

public static <T> java.util.Collection<T> getAll(java.lang.Class<T> dependencyType,
                                                 java.lang.Object dependant)

Gets all dependencies of the specified type. The dependencies are requested from the currently active DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

dependencyType - A Class specifying the type of the requested dependency.

dependant - The object requesting the requested. This parameter is required when the requesting object is also a requested within the object graph represented by the active Dependency.

Returns:

A Collection containing the found dependencies. If an empty Collection is returned, it indicates an error in an DependencyScope implementation or configuration.

getAll

public static <T> java.util.Collection<T> getAll(DependencyScope scope,
                                                 java.lang.Class<T> dependencyType,
                                                 java.lang.Object dependant)

Gets all dependencies of the specified type. The dependencies are requested from the currently active DependencyScope.

Type Parameters:

T - A type parameter for casting the requested dependency to expected type.

Parameters:

scope - A DependencyScope.

dependencyType - A Class specifying the type of the requested dependency.

dependant - The object requesting the requested. This parameter is required when the requesting object is also a requested within the object graph represented by the active Dependency.

Returns:

A Collection containing the found dependencies. If an empty Collection is returned, it indicates an error in an DependencyScope implementation or configuration.

resetAppScope

protected static void resetAppScope()

This method resets the application level DependencyScope to null. This method is added only for testing purposes.

resetActiveScope

public static void resetActiveScope()

This method resets the currently active DependencyScope to null. This method is added only for testing purposes.

addDependant

public static void addDependant(java.lang.Object dependant)

Adds the given Object as an dependant to currently active scope - if one exists.

Parameters:

dependant - An Object to be added as dependant.

removeDependant

public static void removeDependant(java.lang.Object dependant)

Removes the given Object as an dependant from currently active scope - if one exists.

Parameters:

dependant - An Object to be removed as dependant.