com.robopupu.api.feature

Class AbstractFeatureManager

java.lang.Object

com.robopupu.api.dependency.ScopedObject

com.robopupu.api.plugin.AbstractPluginComponent

com.robopupu.api.component.AbstractManager

com.robopupu.api.feature.AbstractFeatureManager

All Implemented Interfaces:

android.app.Application.ActivityLifecycleCallbacks, Manager, Scopeable, FeatureManager, PluginComponent

public abstract class AbstractFeatureManager
extends AbstractManager
implements FeatureManager, android.app.Application.ActivityLifecycleCallbacks

AbstractFeatureManager provides a default implementation of FeatureManager.

Constructor Summary

Constructors

Constructor and Description
AbstractFeatureManager()

Method Summary

Modifier and Type	Method and Description
boolean	conditionallyRestartFeature(Feature feature, FeatureView featureView) Check the execution state of the given Feature and if not started then start the Feature for the given FeatureView.
Feature	createFeature(java.lang.Class<? extends Feature> featureClass) Creates the specified Feature, but does not start it.
java.util.List<Feature>	getActiveChildFeatures(Feature parentFeature) Gets the child Features of the given parent Feature - if any.
java.util.List<Feature>	getActiveFeatures() Gets the currently active Features.
android.app.Application.ActivityLifecycleCallbacks	getActivityLifecycleCallback() Gets an object that implements Application.ActivityLifecycleCallbacks.
FeatureContainer	getFeatureContainer(int featureContainerId) Gets a FeatureContainer with the given ID.
android.app.Activity	getForegroundActivity() Gets the Activity that is currently in foreground.
java.util.List<Feature>	getForegroundFeatures() Gets all the Features that have Views in the foreground.
static FeatureManager	getInstance()
android.app.Activity	getLastPausedActivity() Gets the Activity that is the last paused Activity.
android.app.Activity	getLastStoppedActivity() Gets the Activity that is the last stopped Activity.
java.util.List<Feature>	getPausedFeatures() Gets the currently paused Features.
boolean	hasActiveChildFeatures(Feature parentFeature) Tests the given parent Feature has any child Features.
void	onActivityCreated(android.app.Activity activity, android.os.Bundle inState)
void	onActivityDestroyed(android.app.Activity activity)
void	onActivityPaused(android.app.Activity activity)
void	onActivityResumed(android.app.Activity activity)
void	onActivitySaveInstanceState(android.app.Activity activity, android.os.Bundle outState)
void	onActivityStarted(android.app.Activity activity)
void	onActivityStopped(android.app.Activity activity)
boolean	onBackPressed() Invoked to handle Back Pressed event received by the FeatureContainer.
void	onFeatureDestroyed(Feature feature) Invoked by a PluginStateComponent.destroy() when the Feature} has been destroyed.
void	onFeaturePaused(Feature feature, boolean finishing) Invoked by a PluginStateComponent.pause() when the Feature} has been paused.
void	onFeatureResumed(Feature feature) Invoked by a PluginStateComponent.resume() when the Feature} has been resumed.
void	onFeatureStopped(Feature feature) Invoked by a PluginStateComponent.stop() when the Feature} has been stopped.
void	registerFeatureContainerProvider(FeatureContainerProvider provider) Register the given FeatureContainerProvider for this FeatureManager so that Features can access their FeatureContainers.
static void	setInstance(FeatureManager instance)
void	setMockScopeOwner(DependencyScopeOwner owner) Sets a DependencyScopeOwner that is used to provide a DependencyScope containing mock dependencies for testing purposes.
Feature	startFeature(FeatureContainer featureContainer, java.lang.Class<? extends Feature> featureClass) Creates and starts the specified Feature whose FeatureCompatFragments are hosted by the given FeatureContainer.
Feature	startFeature(FeatureContainer featureContainer, java.lang.Class<? extends Feature> featureClass, Params params) Creates and starts the specified Feature whose FeatureCompatFragments are shown using the given FeatureContainer.
Feature	startFeature(FeatureContainer featureContainer, Feature feature) Starts the given Feature whose Views are shown using the given FeatureContainer.
Feature	startFeature(FeatureContainer featureContainer, Feature feature, Params params) Starts the given Feature whose Views are shown using the given FeatureContainer.
Feature	startFeature(int featureContainerId, java.lang.Class<? extends Feature> featureClass, Params params) Creates and starts the specified Feature whose FeatureCompatFragments are shown using the specified FeatureContainer.
Feature	startFeature(int featureContainerId, Feature feature, Params params) Starts the given Feature whose Views are shown using the specified FeatureContainer.
void	unregisterFeatureContainerProvider(FeatureContainerProvider provider) Unregister the given FeatureContainerProvider from this FeatureManager.

Methods inherited from class com.robopupu.api.plugin.AbstractPluginComponent

onPlugged, onPluginPlugged, onPluginUnplugged, onUnplugged

Methods inherited from class com.robopupu.api.dependency.ScopedObject

getScope, setScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.robopupu.api.plugin.PluginComponent

onPlugged, onPluginPlugged, onPluginUnplugged, onUnplugged

Constructor Detail

AbstractFeatureManager

public AbstractFeatureManager()

Method Detail

getInstance

public static FeatureManager getInstance()

setInstance

public static void setInstance(FeatureManager instance)

getActiveChildFeatures

public java.util.List<Feature> getActiveChildFeatures(Feature parentFeature)

Description copied from interface: FeatureManager

Gets the child Features of the given parent Feature - if any.

Specified by:

getActiveChildFeatures in interface FeatureManager

Parameters:

parentFeature - A parent Feature.

Returns:

A List of child features. May not be null.

hasActiveChildFeatures

public boolean hasActiveChildFeatures(Feature parentFeature)

Description copied from interface: FeatureManager

Tests the given parent Feature has any child Features.

Specified by:

hasActiveChildFeatures in interface FeatureManager

Parameters:

parentFeature - A parent Feature.

Returns:

A boolean

getActivityLifecycleCallback

public android.app.Application.ActivityLifecycleCallbacks getActivityLifecycleCallback()

Description copied from interface: FeatureManager

Gets an object that implements Application.ActivityLifecycleCallbacks.

Specified by:

getActivityLifecycleCallback in interface FeatureManager

Returns:

An object that implements Application.ActivityLifecycleCallbacks.

getForegroundActivity

public android.app.Activity getForegroundActivity()

Description copied from interface: FeatureManager

Gets the Activity that is currently in foreground.

Specified by:

getForegroundActivity in interface FeatureManager

Returns:

An Activity. May return null.

getLastPausedActivity

public android.app.Activity getLastPausedActivity()

Description copied from interface: FeatureManager

Gets the Activity that is the last paused Activity.

Specified by:

getLastPausedActivity in interface FeatureManager

Returns:

An Activity. May return null.

getLastStoppedActivity

public android.app.Activity getLastStoppedActivity()

Description copied from interface: FeatureManager

Gets the Activity that is the last stopped Activity.

Specified by:

getLastStoppedActivity in interface FeatureManager

Returns:

An Activity. May return null.

setMockScopeOwner

public void setMockScopeOwner(DependencyScopeOwner owner)

Description copied from interface: FeatureManager

Sets a DependencyScopeOwner that is used to provide a DependencyScope containing mock dependencies for testing purposes.

Specified by:

setMockScopeOwner in interface FeatureManager

Parameters:

owner - A DependencyScopeOwner.

getActiveFeatures

public java.util.List<Feature> getActiveFeatures()

Description copied from interface: FeatureManager

Gets the currently active Features.

Specified by:

getActiveFeatures in interface FeatureManager

Returns:

A List of Features.

getPausedFeatures

public java.util.List<Feature> getPausedFeatures()

Description copied from interface: FeatureManager

Gets the currently paused Features.

Specified by:

getPausedFeatures in interface FeatureManager

Returns:

A List of Features.

getForegroundFeatures

public java.util.List<Feature> getForegroundFeatures()

Description copied from interface: FeatureManager

Gets all the Features that have Views in the foreground.

Specified by:

getForegroundFeatures in interface FeatureManager

Returns:

A List of Features.

getFeatureContainer

public FeatureContainer getFeatureContainer(int featureContainerId)

Description copied from interface: FeatureManager

Gets a FeatureContainer with the given ID.

Specified by:

getFeatureContainer in interface FeatureManager

Parameters:

featureContainerId - The ID of the FeatureContainer.

Returns:

A FeatureContainer.

createFeature

public Feature createFeature(java.lang.Class<? extends Feature> featureClass)

Description copied from interface: FeatureManager

Creates the specified Feature, but does not start it. If the feature is a DependencyScopeOwner its DependencyScope is added to cache of DependencyScopes.

Specified by:

createFeature in interface FeatureManager

Parameters:

featureClass - A Feature

Returns:

A Feature.

startFeature

public Feature startFeature(FeatureContainer featureContainer,
                            java.lang.Class<? extends Feature> featureClass)

Description copied from interface: FeatureManager

Creates and starts the specified Feature whose FeatureCompatFragments are hosted by the given FeatureContainer.

Specified by:

startFeature in interface FeatureManager

Parameters:

featureContainer - A FeatureContainer.

featureClass - A Class specifying the Feature to be created and started.

Returns:

A Feature.

startFeature

public Feature startFeature(int featureContainerId,
                            java.lang.Class<? extends Feature> featureClass,
                            Params params)

Description copied from interface: FeatureManager

Creates and starts the specified Feature whose FeatureCompatFragments are shown using the specified FeatureContainer.

Specified by:

startFeature in interface FeatureManager

Parameters:

featureContainerId - An ID of the FeatureContainer. In practice the ID is the layout view ID of the ViewGroup that contains the View.

featureClass - A Class specifying the Feature to be created and started.

params - A Params containing parameters for the created and started Feature.

Returns:

A Feature.

startFeature

public Feature startFeature(FeatureContainer featureContainer,
                            java.lang.Class<? extends Feature> featureClass,
                            Params params)

Description copied from interface: FeatureManager

Creates and starts the specified Feature whose FeatureCompatFragments are shown using the given FeatureContainer.

Specified by:

startFeature in interface FeatureManager

Parameters:

featureContainer - A FeatureContainer.

featureClass - A Class specifying the Feature to be created and started.

params - A Params containing parameters for the created and started Feature.

Returns:

A Feature.

startFeature

public Feature startFeature(FeatureContainer featureContainer,
                            Feature feature)

Description copied from interface: FeatureManager

Starts the given Feature whose Views are shown using the given FeatureContainer.

Specified by:

startFeature in interface FeatureManager

Parameters:

featureContainer - A FeatureContainer.

feature - {The Feature to be started.

Returns:

A Feature.

startFeature

public Feature startFeature(FeatureContainer featureContainer,
                            Feature feature,
                            Params params)

Description copied from interface: FeatureManager

Starts the given Feature whose Views are shown using the given FeatureContainer.

Specified by:

startFeature in interface FeatureManager

Parameters:

featureContainer - A FeatureContainer.

feature - {The Feature to be started.

params - A Params containing parameters for the started Feature.

Returns:

A Feature.

startFeature

public Feature startFeature(int featureContainerId,
                            Feature feature,
                            Params params)

Description copied from interface: FeatureManager

Starts the given Feature whose Views are shown using the specified FeatureContainer.

Specified by:

startFeature in interface FeatureManager

Parameters:

featureContainerId - An ID of the FeatureContainer. In practice the ID is the layout view ID of the ViewGroup that contains the View.

feature - {The Feature to be started.

params - A Params containing parameters for the started Feature.

Returns:

A Feature.

conditionallyRestartFeature

public boolean conditionallyRestartFeature(Feature feature,
                                           FeatureView featureView)

Description copied from interface: FeatureManager

Check the execution state of the given Feature and if not started then start the Feature for the given FeatureView.

Specified by:

conditionallyRestartFeature in interface FeatureManager

Parameters:

feature - A Feature.

featureView - A FeatureView.

Returns:

A boolean value if the Feature was restarted.

registerFeatureContainerProvider

public void registerFeatureContainerProvider(FeatureContainerProvider provider)

Description copied from interface: FeatureManager

Register the given FeatureContainerProvider for this FeatureManager so that Features can access their FeatureContainers.

Specified by:

registerFeatureContainerProvider in interface FeatureManager

Parameters:

provider - A FeatureContainerProvider.

unregisterFeatureContainerProvider

public void unregisterFeatureContainerProvider(FeatureContainerProvider provider)

Description copied from interface: FeatureManager

Unregister the given FeatureContainerProvider from this FeatureManager.

Specified by:

unregisterFeatureContainerProvider in interface FeatureManager

Parameters:

provider - A FeatureContainerProvider.

onBackPressed

public boolean onBackPressed()

Invoked to handle Back Pressed event received by the FeatureContainer.

Specified by:

onBackPressed in interface FeatureManager

Returns:

A boolean value indicating if the event was consumed by this method.

onFeatureResumed

public void onFeatureResumed(Feature feature)

Description copied from interface: FeatureManager

Invoked by a PluginStateComponent.resume() when the Feature} has been resumed.

Specified by:

onFeatureResumed in interface FeatureManager

Parameters:

feature - A Feature. May not be null.

onFeaturePaused

public void onFeaturePaused(Feature feature,
                            boolean finishing)

Description copied from interface: FeatureManager

Invoked by a PluginStateComponent.pause() when the Feature} has been paused.

Specified by:

onFeaturePaused in interface FeatureManager

Parameters:

feature - A Feature. May not be null.

finishing - A boolean value indicating if the PluginStateComponent is going to be finished i.e. it is not resumed nor restarted anymore.

onFeatureStopped

public void onFeatureStopped(Feature feature)

Description copied from interface: FeatureManager

Invoked by a PluginStateComponent.stop() when the Feature} has been stopped.

Specified by:

onFeatureStopped in interface FeatureManager

Parameters:

feature - A Feature. May not be null.

onFeatureDestroyed

public void onFeatureDestroyed(Feature feature)

Description copied from interface: FeatureManager

Invoked by a PluginStateComponent.destroy() when the Feature} has been destroyed.

Specified by:

onFeatureDestroyed in interface FeatureManager

Parameters:

feature - A Feature. May not be null.

onActivityCreated

public void onActivityCreated(android.app.Activity activity,
                              android.os.Bundle inState)

Specified by:

onActivityCreated in interface android.app.Application.ActivityLifecycleCallbacks

onActivityStarted

public void onActivityStarted(android.app.Activity activity)

Specified by:

onActivityStarted in interface android.app.Application.ActivityLifecycleCallbacks

onActivityResumed

public void onActivityResumed(android.app.Activity activity)

Specified by:

onActivityResumed in interface android.app.Application.ActivityLifecycleCallbacks

onActivityPaused

public void onActivityPaused(android.app.Activity activity)

Specified by:

onActivityPaused in interface android.app.Application.ActivityLifecycleCallbacks

onActivityStopped

public void onActivityStopped(android.app.Activity activity)

Specified by:

onActivityStopped in interface android.app.Application.ActivityLifecycleCallbacks

onActivitySaveInstanceState

public void onActivitySaveInstanceState(android.app.Activity activity,
                                        android.os.Bundle outState)

Specified by:

onActivitySaveInstanceState in interface android.app.Application.ActivityLifecycleCallbacks

onActivityDestroyed

public void onActivityDestroyed(android.app.Activity activity)

Specified by:

onActivityDestroyed in interface android.app.Application.ActivityLifecycleCallbacks