AbstractPluginStateComponent (robopupu-api API)

java.lang.Object
- com.robopupu.api.dependency.ScopedObject
- - com.robopupu.api.plugin.AbstractPluginComponent
  - - com.robopupu.api.plugin.AbstractPluginStateComponent

All Implemented Interfaces:

Scopeable, PluginComponent, PluginStateComponent

Direct Known Subclasses:

AbstractFeature, AbstractInteractor, AbstractModel, AbstractPresenter
```
public class AbstractPluginStateComponent
extends AbstractPluginComponent
implements PluginStateComponent
```
AbstractPluginStateComponent provides an abstract base class for implementing PluginStateComponents.

Field Summary

Fields
Modifier and Type Field and Description

protected Params params

Fields
Modifier and Type	Field and Description
`protected Params`	`params`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractPluginStateComponent()

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Invoked to set the state of `PluginStateComponent` to be destroyed.
`LifecycleState`	`getLifecycleState()` Gets the current `LifecycleState` of this `PluginStateComponent`.
`Params`	`getParams()`
`PluginState`	`getState()` Gets the current state of this `PluginStateComponent`.
`boolean`	`isDestroyed()` Tests if destroyed.
`boolean`	`isPaused()` Tests if paused.
`boolean`	`isRestarted()` Tests if restarted.
`boolean`	`isResumed()` Tests if paused.
`boolean`	`isStarted()` Tests if started.
`boolean`	`isStopped()` Tests if stopped.
`protected void`	`onCreate(Params params)`
`protected void`	`onDestroy()`
`protected void`	`onPause()`
`protected void`	`onRestart()`
`protected void`	`onResume()`
`protected void`	`onStart()`
`protected void`	`onStop()`
`void`	`pause()` Invoked to pause this `PluginStateComponent`.
`void`	`restart()` Invoked to restart this `PluginStateComponent`.
`void`	`resume()` Invoked to resume this `PluginStateComponent`.
`void`	`start()` Invoked to start this `PluginStateComponent` without parameters.
`void`	`start(Params params)` Invoked to start the `PluginStateComponent` using the given parameters.
`void`	`stop()` Invoked to set the state of `PluginStateComponent` to be stopped.

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

- Field Detail
  - params
```
protected Params params
```
- Constructor Detail
  - AbstractPluginStateComponent
```
protected AbstractPluginStateComponent()
```
- Method Detail
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    Description copied from interface: PluginStateComponent
    
    Gets the current LifecycleState of this PluginStateComponent.
    
    Specified by:
    
    getLifecycleState in interface PluginStateComponent
    
    Returns:
    
    A LifecycleState.
  - getParams
```
public Params getParams()
```
  - pause
```
public void pause()
```
    Description copied from interface: PluginStateComponent
    
    Invoked to pause this PluginStateComponent.
    
    Specified by:
    
    pause in interface PluginStateComponent
  - resume
```
public void resume()
```
    Description copied from interface: PluginStateComponent
    
    Invoked to resume this PluginStateComponent.
    
    Specified by:
    
    resume in interface PluginStateComponent
  - restart
```
public void restart()
```
    Description copied from interface: PluginStateComponent
    
    Invoked to restart this PluginStateComponent.
    
    Specified by:
    
    restart in interface PluginStateComponent
  - start
```
public final void start()
```
    Description copied from interface: PluginStateComponent
    
    Invoked to start this PluginStateComponent without parameters.
    
    Specified by:
    
    start in interface PluginStateComponent
  - start
```
public final void start(Params params)
```
    Description copied from interface: PluginStateComponent
    
    Invoked to start the PluginStateComponent using the given parameters.
    
    Specified by:
    
    start in interface PluginStateComponent
    
    Parameters:
    
    params - A Params. May not be null.
  - stop
```
public 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
  - destroy
```
public 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
  - getState
```
public PluginState getState()
```
    Description copied from interface: PluginStateComponent
    
    Gets the current state of this PluginStateComponent.
    
    Specified by:
    
    getState in interface PluginStateComponent
    
    Returns:
    
    The state as a PluginState.
  - onCreate
```
protected void onCreate(Params params)
```
  - onStart
```
protected void onStart()
```
  - onRestart
```
protected void onRestart()
```
  - onResume
```
protected void onResume()
```
  - onPause
```
protected void onPause()
```
  - onStop
```
protected void onStop()
```
  - onDestroy
```
protected void onDestroy()
```
  - isPaused
```
public boolean isPaused()
```
    Description copied from interface: PluginStateComponent
    
    Tests if paused.
    
    Specified by:
    
    isPaused in interface PluginStateComponent
    
    Returns:
    
    A boolean.
  - isRestarted
```
public boolean isRestarted()
```
    Description copied from interface: PluginStateComponent
    
    Tests if restarted.
    
    Specified by:
    
    isRestarted in interface PluginStateComponent
    
    Returns:
    
    A boolean.
  - isResumed
```
public boolean isResumed()
```
    Description copied from interface: PluginStateComponent
    
    Tests if paused.
    
    Specified by:
    
    isResumed in interface PluginStateComponent
    
    Returns:
    
    A boolean.
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: PluginStateComponent
    
    Tests if started.
    
    Specified by:
    
    isStarted in interface PluginStateComponent
    
    Returns:
    
    A boolean.
  - isStopped
```
public boolean isStopped()
```
    Description copied from interface: PluginStateComponent
    
    Tests if stopped.
    
    Specified by:
    
    isStopped in interface PluginStateComponent
    
    Returns:
    
    A boolean.
  - isDestroyed
```
public boolean isDestroyed()
```
    Description copied from interface: PluginStateComponent
    
    Tests if destroyed.
    
    Specified by:
    
    isDestroyed in interface PluginStateComponent
    
    Returns:
    
    A boolean.

Class AbstractPluginStateComponent

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

params

Constructor Detail

AbstractPluginStateComponent

Method Detail

getLifecycleState

getParams

pause

resume

restart

start

start

stop

destroy

getState

onCreate

onStart

onRestart

onResume

onPause

onStop

onDestroy

isPaused

isRestarted

isResumed

isStarted

isStopped

isDestroyed