PluginStateComponent (robopupu-api API)

All Superinterfaces:

PluginComponent

All Known Subinterfaces:

Feature, Interactor

All Known Implementing Classes:

AbstractFeature, AbstractFeaturePresenter, AbstractInteractor, AbstractListModel, AbstractModel, AbstractPluginStateComponent, AbstractPresenter, StateMachineInteractor
```
public interface PluginStateComponent
extends PluginComponent
```
PluginStateComponent extends PluginComponent to define an interface for plugin components that maintain PluginState.

Method Summary

All Methods Instance Methods Abstract 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`.
`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.
`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 interface com.robopupu.api.plugin.PluginComponent
onPlugged, onPluginPlugged, onPluginUnplugged, onUnplugged

- Method Detail
  - getLifecycleState
```
LifecycleState getLifecycleState()
```
    Gets the current LifecycleState of this PluginStateComponent.
    
    Returns:
    
    A LifecycleState.
  - getState
```
PluginState getState()
```
    Gets the current state of this PluginStateComponent.
    
    Returns:
    
    The state as a PluginState.
  - pause
```
void pause()
```
    Invoked to pause this PluginStateComponent.
  - resume
```
void resume()
```
    Invoked to resume this PluginStateComponent.
  - restart
```
void restart()
```
    Invoked to restart this PluginStateComponent.
  - start
```
void start()
```
    Invoked to start this PluginStateComponent without parameters.
  - start
```
void start(Params params)
```
    Invoked to start the PluginStateComponent using the given parameters.
    
    Parameters:
    
    params - A Params. May not be null.
  - stop
```
void stop()
```
    Invoked to set the state of PluginStateComponent to be stopped. A stopped PluginStateComponent is unplugged from PluginBus.
  - destroy
```
void destroy()
```
    Invoked to set the state of PluginStateComponent to be destroyed. This method is automatically invoked for a stopped PluginStateComponent.
  - isPaused
```
boolean isPaused()
```
    Tests if paused.
    
    Returns:
    
    A boolean.
  - isRestarted
```
boolean isRestarted()
```
    Tests if restarted.
    
    Returns:
    
    A boolean.
  - isResumed
```
boolean isResumed()
```
    Tests if paused.
    
    Returns:
    
    A boolean.
  - isStarted
```
boolean isStarted()
```
    Tests if started.
    
    Returns:
    
    A boolean.
  - isStopped
```
boolean isStopped()
```
    Tests if stopped.
    
    Returns:
    
    A boolean.
  - isDestroyed
```
boolean isDestroyed()
```
    Tests if destroyed.
    
    Returns:
    
    A boolean.

Interface PluginStateComponent

Method Summary

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

Method Detail

getLifecycleState

getState

pause

resume

restart

start

start

stop

destroy

isPaused

isRestarted

isResumed

isStarted

isStopped

isDestroyed