com.robopupu.api.feature

Interface FeatureManager

All Superinterfaces:

Manager, PluginComponent

All Known Implementing Classes:

AbstractFeatureManager

public interface FeatureManager
extends Manager

FeatureManager defines an interface for Manager component that provides an API for managing Features.

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.
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.
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.
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 interface com.robopupu.api.plugin.PluginComponent

onPlugged, onPluginPlugged, onPluginUnplugged, onUnplugged

Method Detail

getActivityLifecycleCallback

android.app.Application.ActivityLifecycleCallbacks getActivityLifecycleCallback()

Gets an object that implements Application.ActivityLifecycleCallbacks.

Returns:

An object that implements Application.ActivityLifecycleCallbacks.

getActiveChildFeatures

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

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

Parameters:

parentFeature - A parent Feature.

Returns:

A List of child features. May not be null.

hasActiveChildFeatures

boolean hasActiveChildFeatures(Feature parentFeature)

Tests the given parent Feature has any child Features.

Parameters:

parentFeature - A parent Feature.

Returns:

A boolean

getForegroundActivity

android.app.Activity getForegroundActivity()

Gets the Activity that is currently in foreground.

Returns:

An Activity. May return null.

getLastPausedActivity

android.app.Activity getLastPausedActivity()

Gets the Activity that is the last paused Activity.

Returns:

An Activity. May return null.

getLastStoppedActivity

android.app.Activity getLastStoppedActivity()

Gets the Activity that is the last stopped Activity.

Returns:

An Activity. May return null.

setMockScopeOwner

void setMockScopeOwner(DependencyScopeOwner owner)

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

Parameters:

owner - A DependencyScopeOwner.

getActiveFeatures

java.util.List<Feature> getActiveFeatures()

Gets the currently active Features.

Returns:

A List of Features.

getPausedFeatures

java.util.List<Feature> getPausedFeatures()

Gets the currently paused Features.

Returns:

A List of Features.

getForegroundFeatures

java.util.List<Feature> getForegroundFeatures()

Gets all the Features that have Views in the foreground.

Returns:

A List of Features.

getFeatureContainer

FeatureContainer getFeatureContainer(int featureContainerId)

Gets a FeatureContainer with the given ID.

Parameters:

featureContainerId - The ID of the FeatureContainer.

Returns:

A FeatureContainer.

createFeature

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

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

Parameters:

featureClass - A Feature

Returns:

A Feature.

startFeature

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

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

Parameters:

featureContainer - A FeatureContainer.

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

Returns:

A Feature.

startFeature

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.

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

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.

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

Feature startFeature(FeatureContainer featureContainer,
                     Feature feature)

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

Parameters:

featureContainer - A FeatureContainer.

feature - {The Feature to be started.

Returns:

A Feature.

startFeature

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

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

Parameters:

featureContainer - A FeatureContainer.

feature - {The Feature to be started.

params - A Params containing parameters for the started Feature.

Returns:

A Feature.

startFeature

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

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

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.

onBackPressed

boolean onBackPressed()

Invoked to handle Back Pressed event received by the FeatureContainer.

Returns:

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

onFeatureResumed

void onFeatureResumed(Feature feature)

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

Parameters:

feature - A Feature. May not be null.

onFeaturePaused

void onFeaturePaused(Feature feature,
                     boolean finishing)

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

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

void onFeatureStopped(Feature feature)

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

Parameters:

feature - A Feature. May not be null.

onFeatureDestroyed

void onFeatureDestroyed(Feature feature)

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

Parameters:

feature - A Feature. May not be null.

registerFeatureContainerProvider

void registerFeatureContainerProvider(FeatureContainerProvider provider)

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

Parameters:

provider - A FeatureContainerProvider.

unregisterFeatureContainerProvider

void unregisterFeatureContainerProvider(FeatureContainerProvider provider)

Unregister the given FeatureContainerProvider from this FeatureManager.

Parameters:

provider - A FeatureContainerProvider.

conditionallyRestartFeature

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.

Parameters:

feature - A Feature.

featureView - A FeatureView.

Returns:

A boolean value if the Feature was restarted.