com.robopupu.api.plugin

Class PluginState

java.lang.Object

com.robopupu.api.plugin.PluginState

public class PluginState
extends java.lang.Object

PluginState represents the current state of a PluginStateComponent.

Constructor Summary

Constructors

Constructor and Description
PluginState()

Method Summary

Modifier and Type	Method and Description
LifecycleState	getLifecycleState() Gets the current LifecycleState of this PluginStateComponent.
boolean	isCreated() Tests if the LifecycleState is created.
boolean	isDestroyed() Tests if the LifecycleState is destroyed.
boolean	isDormant() Tests if the LifecycleState is dormant.
boolean	isPaused() Tests if the LifecycleState is paused.
boolean	isRestarted() Tests if the LifecycleState is isRestarted.
boolean	isResumed() Tests if the LifecycleState is resumed.
boolean	isStarted() Tests if the LifecycleState is started or resumed.
boolean	isStopped() Tests if the LifecycleState is stopped.
void	onCreate() Invoked when the PluginComponent is created.
void	onDestroy() Invoked when the PluginComponent is destroyed.
void	onPause() Invoked when the PluginComponent is paused.
void	onRestart() Invoked when the PluginComponent is restarted.
void	onResume() Invoked when the PluginComponent is resumed.
void	onStart() Invoked when the PluginComponent is started.
void	onStop() Invoked when the PluginComponent is stopped.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginState

public PluginState()

Method Detail

getLifecycleState

public LifecycleState getLifecycleState()

Gets the current LifecycleState of this PluginStateComponent.

Returns:

A

isDormant

public boolean isDormant()

Tests if the LifecycleState is dormant. In dormant state the PluginStateComponent is instantiated, but not initialised.

Returns:

A boolean value.

isCreated

public boolean isCreated()

Tests if the LifecycleState is created. In created state the PluginStateComponent is initialised and is ready to be started.

Returns:

A boolean value.

isStarted

public boolean isStarted()

Tests if the LifecycleState is started or resumed. In started state the method PluginStateComponent.start() and possibly PluginStateComponent.resume() have been invoked. Method getLifecycleState() can be used to determinate the exact lifecycle state.

Returns:

A boolean value.

isResumed

public boolean isResumed()

Tests if the LifecycleState is resumed. In resumed state both the methods PluginStateComponent.start() and PluginStateComponent.resume() have been invoked.

Returns:

A boolean value.

isPaused

public boolean isPaused()

Tests if the LifecycleState is paused. In paused state the method PluginStateComponent.pause() has been invoked.

Returns:

A boolean value.

isRestarted

public boolean isRestarted()

Tests if the LifecycleState is isRestarted. In isRestarted state the method PluginStateComponent.start() and possibly PluginStateComponent.resume() have been invoked.

Returns:

A boolean value.

isStopped

public boolean isStopped()

Tests if the LifecycleState is stopped. In stopped state the method PluginStateComponent.stop() and possibly PluginStateComponent.destroy() have been invoked.

Returns:

A boolean value.

isDestroyed

public boolean isDestroyed()

Tests if the LifecycleState is destroyed. In destroyed state the method PluginStateComponent.destroy() has been invoked.

Returns:

A boolean value.

onCreate

public void onCreate()

Invoked when the PluginComponent is created.

onStart

public void onStart()

Invoked when the PluginComponent is started.

onRestart

public void onRestart()

Invoked when the PluginComponent is restarted.

onPause

public void onPause()

Invoked when the PluginComponent is paused.

onResume

public void onResume()

Invoked when the PluginComponent is resumed.

onStop

public void onStop()

Invoked when the PluginComponent is stopped.

onDestroy

public void onDestroy()

Invoked when the PluginComponent is destroyed.