com.robopupu.api.feature

Class AbstractFeature

java.lang.Object

com.robopupu.api.dependency.ScopedObject

com.robopupu.api.plugin.AbstractPluginComponent

com.robopupu.api.plugin.AbstractPluginStateComponent

com.robopupu.api.feature.AbstractFeature

All Implemented Interfaces:

DependencyScopeOwner, Scopeable, Feature, PresenterListener, PluginComponent, PluginStateComponent

public abstract class AbstractFeature
extends AbstractPluginStateComponent
implements Feature, DependencyScopeOwner

AbstractFeature provides an abstract base class for implementing Features.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<FeatureView>	activeViews
protected java.util.HashMap<java.lang.String,FeatureView>	backStackViews
protected int	featureContainerId
protected FeatureManager	featureManager
protected DependencyScope	featureScope
protected boolean	isActivityFeature
protected Feature	parentFeature
protected java.lang.Class<? extends DependencyScope>	scopeClass

Fields inherited from class com.robopupu.api.plugin.AbstractPluginStateComponent

params

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFeature(java.lang.Class<? extends DependencyScope> scopeClass) Construct a new instance of AbstractFeature.
protected	AbstractFeature(java.lang.Class<? extends DependencyScope> scopeClass, boolean isActivityFeature) Construct a new instance of AbstractFeature.

Method Summary

Modifier and Type	Method and Description
FeatureView	addActiveView(FeatureView view) Adds the given FeatureView to the set of currently active FeatureViews of this Feature.
protected void	addBackStackView(java.lang.String tag, FeatureView view) Adds the given FeatureView to the HashMap that contains all the FeatureViews of this Feature that has been added to back stack.
boolean	canGoBack() Tests if the previous FeatureView can be navigated back to.
void	clearBackStack() Clears the back stack managed by FragmentManager.
void	destroy() Invoked to set the state of PluginStateComponent to be destroyed.
void	finish() Finishes this Feature
java.util.List<FeatureView>	getActiveViews() Gets the currently active FeatureViews.
protected static java.lang.Class<? extends FeatureView>	getClass(FeatureView view)
FeatureContainer	getFeatureContainer() Gets the FeatureContainer that hosts the FeatureCompatFragments of this Feature.
protected DependencyScope	getFeatureScope()
DependencyScope	getOwnedScope() Gets the DependencyScope owned by this DependencyScopeOwner.
Feature	getParentFeature() Gets the parent Feature of this Feature.
java.lang.Class<? extends DependencyScope>	getScopeClass() Gets the Class of DependencyScope owned by this DependencyScopeOwner.
void	goBack() Goes back to previous FeatureView.
boolean	hasBackStackViews() Tests if this Feature has any FeatureViews in back stack.
boolean	hasForegroundView() Tests if this Feature is in foreground i.e.
void	hideView(java.lang.Class<? extends Presenter> presenterClass, boolean addedToBackStack, java.lang.String tag) Hides the FeatureView attached to the given Presenter.
void	hideView(FeaturePresenter presenter, boolean addedToBackStack, java.lang.String tag) Hides the FeatureView attached to the given Presenter.
boolean	isActiveView(FeatureView view) Tests if the given FeatureView is currently active one.
boolean	isActivityFeature() Tests if this Feature is set to be an Activity Feature that is owned and controlled by an Activity.
boolean	isBackPressedEventHandler() Tests if this Feature handles the back pressed event.
void	onFeatureContainerPaused(FeatureContainer container, boolean finishing) Invoked when a FeatureContainer has been paused.
void	onFeatureContainerResumed(FeatureContainer container) Invoked when a FeatureContainer has been resumed.
void	onFeatureContainerStarted(FeatureContainer container) Invoked when a FeatureContainer has been started.
void	onFeatureContainerStopped(FeatureContainer container, boolean finishing) Invoked when a FeatureContainer has been stopped.
protected void	onPause(boolean finishing) Invoked by Feature.pause(boolean).
void	onPresenterFinished(Presenter presenter) Invoked by a Presenter when it has been finished by invoking Presenter.finish().
void	pause() Invoked to pause this PluginStateComponent.
void	pause(boolean finishing) Invoked to pause this Feature.
<T> T	plug(java.lang.Class<?> pluginClass) Plugs an instance of specific Class to PluginBus.
<T> T	plug(java.lang.Object plugin) Plugs the the given plugin Object to this PluginBus.
FeatureView	removeActiveView(FeatureView view) Removes the given FeatureView from the set of currently active FeatureViews of this Feature.
protected void	removeBackStackView(java.lang.String tag) Removes the specified FeatureView from the HashMap that contains all the FeatureViews of this Feature that has been added to back stack.
void	resume() Invoked to resume this PluginStateComponent.
void	setActivityFeature(boolean isActivityFeature) Sets this Feature to be an Activity Feature that is owned and controlled by an Activity.
void	setFeatureContainer(FeatureContainer container) Sets the the FeatureContainer that hosts the FeatureCompatFragments of this Feature.
void	setFeatureManager(FeatureManager manager) Sets the FeatureManager that started this Feature.
void	setParentFeature(Feature parentFeature) Sets the parent Feature of this Feature.
FeatureView	showView(java.lang.Class<? extends Presenter> presenterClass, boolean addToBackStack, Params... params) Shows the FeatureView attached to the specified Presenter.
FeatureView	showView(FeatureTransitionManager transitionManager, java.lang.Class<? extends Presenter> presenterClass, boolean addToBackStack, java.lang.String tag, Params... params) Shows the FeatureView attached to the specified Presenter.
FeatureView	showView(int featureContainerId, java.lang.Class<? extends Presenter> presenterClass, boolean addToBackStack, java.lang.String tag, Params... params) Shows the FeatureView attached to the specified Presenter.
void	stop() Invoked to set the state of PluginStateComponent to be stopped.
void	unplug(java.lang.Object plugin) Unplugs the the given plugin Object to this PluginBus.

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

getLifecycleState, getParams, getState, isDestroyed, isPaused, isRestarted, isResumed, isStarted, isStopped, onCreate, onDestroy, onPause, onRestart, onResume, onStart, onStop, restart, start, start

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.feature.Feature

getParams

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

getLifecycleState, getState, isDestroyed, isPaused, isRestarted, isResumed, isStarted, isStopped, restart, start, start

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

onPlugged, onPluginPlugged, onPluginUnplugged, onUnplugged

Field Detail

activeViews

protected final java.util.ArrayList<FeatureView> activeViews

backStackViews

protected final java.util.HashMap<java.lang.String,FeatureView> backStackViews

featureContainerId

protected int featureContainerId

featureManager

protected FeatureManager featureManager

featureScope

protected DependencyScope featureScope

isActivityFeature

protected boolean isActivityFeature

parentFeature

protected Feature parentFeature

scopeClass

protected java.lang.Class<? extends DependencyScope> scopeClass

Constructor Detail

AbstractFeature

protected AbstractFeature(java.lang.Class<? extends DependencyScope> scopeClass)

Construct a new instance of AbstractFeature.

Parameters:

scopeClass - The Class of the owned DependencyScope.

AbstractFeature

protected AbstractFeature(java.lang.Class<? extends DependencyScope> scopeClass,
                          boolean isActivityFeature)

Construct a new instance of AbstractFeature.

Parameters:

scopeClass - The Class of the owned DependencyScope.

isActivityFeature - A boolean flag specifying if this AbstractFeature is an Activity Feature.

Method Detail

getScopeClass

public java.lang.Class<? extends DependencyScope> getScopeClass()

Description copied from interface: DependencyScopeOwner

Gets the Class of DependencyScope owned by this DependencyScopeOwner.

Specified by:

getScopeClass in interface DependencyScopeOwner

Returns:

A Class.

getOwnedScope

public DependencyScope getOwnedScope()

Description copied from interface: DependencyScopeOwner

Gets the DependencyScope owned by this DependencyScopeOwner.

Specified by:

getOwnedScope in interface DependencyScopeOwner

Returns:

A DependencyScope.

getFeatureScope

protected DependencyScope getFeatureScope()

getParentFeature

public Feature getParentFeature()

Description copied from interface: Feature

Gets the parent Feature of this Feature.

Specified by:

getParentFeature in interface Feature

Returns:

A Feature.

setParentFeature

public void setParentFeature(Feature parentFeature)

Description copied from interface: Feature

Sets the parent Feature of this Feature.

Specified by:

setParentFeature in interface Feature

Parameters:

parentFeature - A Feature.

getActiveViews

public final java.util.List<FeatureView> getActiveViews()

Description copied from interface: Feature

Gets the currently active FeatureViews.

Specified by:

getActiveViews in interface Feature

Returns:

A List containing the currently active views as FeatureViews.

addActiveView

public final FeatureView addActiveView(FeatureView view)

Description copied from interface: Feature

Adds the given FeatureView to the set of currently active FeatureViews of this Feature.

Specified by:

addActiveView in interface Feature

Parameters:

view - A FeatureView to be added.

Returns:

The FeatureView if it was added as a new active FeatureView.

removeActiveView

public final FeatureView removeActiveView(FeatureView view)

Description copied from interface: Feature

Removes the given FeatureView from the set of currently active FeatureViews of this Feature.

Specified by:

removeActiveView in interface Feature

Parameters:

view - A FeatureView to be removed.

Returns:

The FeatureView if it was removed from being an active FeatureView.

addBackStackView

protected final void addBackStackView(java.lang.String tag,
                                      FeatureView view)

Adds the given FeatureView to the HashMap that contains all the FeatureViews of this Feature that has been added to back stack.

Parameters:

tag - The tag of the added FeatureView.

view - The FeatureView that has been added.

removeBackStackView

protected final void removeBackStackView(java.lang.String tag)

Removes the specified FeatureView from the HashMap that contains all the FeatureViews of this Feature that has been added to back stack.

Parameters:

tag - The tag specifying the FeatureView to be removed.

hasForegroundView

public boolean hasForegroundView()

Description copied from interface: Feature

Tests if this Feature is in foreground i.e. it has at least one visible FeatureView.

Specified by:

hasForegroundView in interface Feature

Returns:

A boolean value.

setActivityFeature

public void setActivityFeature(boolean isActivityFeature)

Description copied from interface: Feature

Sets this Feature to be an Activity Feature that is owned and controlled by an Activity.

Specified by:

setActivityFeature in interface Feature

Parameters:

isActivityFeature - A boolean value.

isActivityFeature

public boolean isActivityFeature()

Description copied from interface: Feature

Tests if this Feature is set to be an Activity Feature that is owned and controlled by an Activity.

Specified by:

isActivityFeature in interface Feature

Returns:

A boolean value.

isActiveView

public boolean isActiveView(FeatureView view)

Description copied from interface: Feature

Tests if the given FeatureView is currently active one.

Specified by:

isActiveView in interface Feature

Parameters:

view - A FeatureView.

Returns:

A boolean value.

setFeatureManager

public void setFeatureManager(FeatureManager manager)

Description copied from interface: Feature

Sets the FeatureManager that started this Feature.

Specified by:

setFeatureManager in interface Feature

Parameters:

manager - A FeatureManager.

getFeatureContainer

public FeatureContainer getFeatureContainer()

Description copied from interface: Feature

Gets the FeatureContainer that hosts the FeatureCompatFragments of this Feature.

Specified by:

getFeatureContainer in interface Feature

Returns:

A FeatureContainer.

setFeatureContainer

public void setFeatureContainer(FeatureContainer container)

Description copied from interface: Feature

Sets the the FeatureContainer that hosts the FeatureCompatFragments of this Feature.

Specified by:

setFeatureContainer in interface Feature

Parameters:

container - A FeatureContainer.

showView

public FeatureView showView(java.lang.Class<? extends Presenter> presenterClass,
                            boolean addToBackStack,
                            Params... params)

Shows the FeatureView attached to the specified Presenter.

Specified by:

showView in interface Feature

Parameters:

presenterClass - A Class specifying the Presenter.

addToBackStack - A boolean value specifying if the FeatureView is added to back stack.

params - Optional Params.

Returns:

A FeatureView. May be PlugInvoker.

showView

public FeatureView showView(int featureContainerId,
                            java.lang.Class<? extends Presenter> presenterClass,
                            boolean addToBackStack,
                            java.lang.String tag,
                            Params... params)

Shows the FeatureView attached to the specified Presenter. The FeatureView is shown using the specified FeatureContainer.

Specified by:

showView in interface Feature

Parameters:

featureContainerId - An id of the FeatureContainer.

presenterClass - A Class specifying the Presenter.

addToBackStack - A boolean value specifying if the FeatureView is to be added to back stack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

params - Optional Params.

Returns:

A FeatureView. May be PlugInvoker.

showView

public FeatureView showView(FeatureTransitionManager transitionManager,
                            java.lang.Class<? extends Presenter> presenterClass,
                            boolean addToBackStack,
                            java.lang.String tag,
                            Params... params)

Shows the FeatureView attached to the specified Presenter. The FeatureView is shown using the given FeatureTransitionManager.

Specified by:

showView in interface Feature

Parameters:

transitionManager - A FeatureTransitionManager.

presenterClass - A Class specifying the Presenter.

addToBackStack - A boolean value specifying if the FeatureView is to be added to back stack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

params - Optional Params.

Returns:

A FeatureView. May be PlugInvoker.

hideView

public void hideView(java.lang.Class<? extends Presenter> presenterClass,
                     boolean addedToBackStack,
                     java.lang.String tag)

Hides the FeatureView attached to the given Presenter.

Specified by:

hideView in interface Feature

Parameters:

presenterClass - A Presenter.

addedToBackStack - A boolean value specifying if the FeatureView was added to backstack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

hideView

public void hideView(FeaturePresenter presenter,
                     boolean addedToBackStack,
                     java.lang.String tag)

Hides the FeatureView attached to the given Presenter.

Specified by:

hideView in interface Feature

Parameters:

presenter - A Presenter.

addedToBackStack - A boolean value specifying if the FeatureView was added to backstack.

tag - A tag for the FeatureView used for FragmentTransaction. May be null.

clearBackStack

public void clearBackStack()

Description copied from interface: Feature

Clears the back stack managed by FragmentManager.

Specified by:

clearBackStack in interface Feature

goBack

public void goBack()

Description copied from interface: Feature

Goes back to previous FeatureView.

Specified by:

goBack in interface Feature

getClass

protected static java.lang.Class<? extends FeatureView> getClass(FeatureView view)

isBackPressedEventHandler

public boolean isBackPressedEventHandler()

Description copied from interface: Feature

Tests if this Feature handles the back pressed event.

Specified by:

isBackPressedEventHandler in interface Feature

Returns:

A boolean value.

hasBackStackViews

public boolean hasBackStackViews()

Description copied from interface: Feature

Tests if this Feature has any FeatureViews in back stack.

Specified by:

hasBackStackViews in interface Feature

Returns:

A boolean value.

canGoBack

public boolean canGoBack()

Description copied from interface: Feature

Tests if the previous FeatureView can be navigated back to.

Specified by:

canGoBack in interface Feature

Returns:

A boolean value.

plug

public <T> T plug(java.lang.Class<?> pluginClass)

Plugs an instance of specific Class to PluginBus.

Parameters:

pluginClass - A Class

Returns:

The plugged instance as an Object

plug

public <T> T plug(java.lang.Object plugin)

Plugs the the given plugin Object to this PluginBus.

Parameters:

plugin - A plugin Object.

unplug

public void unplug(java.lang.Object plugin)

Unplugs the the given plugin Object to this PluginBus.

Parameters:

plugin - A plugin Object.

pause

public final void pause()

Description copied from interface: PluginStateComponent

Invoked to pause this PluginStateComponent.

Specified by:

pause in interface PluginStateComponent

Overrides:

pause in class AbstractPluginStateComponent

pause

public final void pause(boolean finishing)

Description copied from interface: Feature

Invoked to pause this Feature.

Specified by:

pause in interface Feature

Parameters:

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

resume

public final void resume()

Description copied from interface: PluginStateComponent

Invoked to resume this PluginStateComponent.

Specified by:

resume in interface PluginStateComponent

Overrides:

resume in class AbstractPluginStateComponent

stop

public final void stop()

Description copied from interface: PluginStateComponent

Invoked to set the state of PluginStateComponent to be stopped. A stopped PluginStateComponent is unplugged from PluginBus.

Specified by:

stop in interface PluginStateComponent

Overrides:

stop in class AbstractPluginStateComponent

finish

public final void finish()

Finishes this Feature

Specified by:

finish in interface Feature

destroy

public final void destroy()

Description copied from interface: PluginStateComponent

Invoked to set the state of PluginStateComponent to be destroyed. This method is automatically invoked for a stopped PluginStateComponent.

Specified by:

destroy in interface PluginStateComponent

Overrides:

destroy in class AbstractPluginStateComponent

onPause

protected void onPause(boolean finishing)

Invoked by Feature.pause(boolean).

Parameters:

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

onPresenterFinished

public void onPresenterFinished(Presenter presenter)

Description copied from interface: PresenterListener

Invoked by a Presenter when it has been finished by invoking Presenter.finish().

Specified by:

onPresenterFinished in interface PresenterListener

Parameters:

presenter - The finished Presenter.

onFeatureContainerPaused

public void onFeatureContainerPaused(FeatureContainer container,
                                     boolean finishing)

Description copied from interface: Feature

Invoked when a FeatureContainer has been paused.

Specified by:

onFeatureContainerPaused in interface Feature

Parameters:

container - A FeatureContainer.

finishing - A boolean flag indicating if the FeatureContainer is finishing.

onFeatureContainerResumed

public void onFeatureContainerResumed(FeatureContainer container)

Description copied from interface: Feature

Invoked when a FeatureContainer has been resumed.

Specified by:

onFeatureContainerResumed in interface Feature

Parameters:

container - A FeatureContainer.

onFeatureContainerStarted

public void onFeatureContainerStarted(FeatureContainer container)

Description copied from interface: Feature

Invoked when a FeatureContainer has been started.

Specified by:

onFeatureContainerStarted in interface Feature

Parameters:

container - A FeatureContainer.

onFeatureContainerStopped

public void onFeatureContainerStopped(FeatureContainer container,
                                      boolean finishing)

Description copied from interface: Feature

Invoked when a FeatureContainer has been stopped.

Specified by:

onFeatureContainerStopped in interface Feature

Parameters:

container - A FeatureContainer.

finishing - A boolean flag indicating if the FeatureContainer is finishing.