com.explodingbacon.bcnlib.framework

Class Command

java.lang.Object

com.explodingbacon.bcnlib.framework.Command

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

CommandGroup

public abstract class Command
extends java.lang.Object
implements java.lang.Runnable

Constructor Summary

Constructors

Constructor and Description
Command() Creates a new Command.

Method Summary

Modifier and Type	Method and Description
void	forceStop()
abstract boolean	isFinished() User-implemented method to check if onLoop should stop executing.
boolean	isRunning() Checks if this Command is currently running.
abstract void	onInit() Runs once every time this Command is started.
abstract void	onLoop() Runs continuously until isFinished returns true.
abstract void	onStop() Runs once when isFinished returns true and onLoop finishes.
void	run() Manages the lifecycle of this Command
void	start() Called to start the Command
void	stop() Forces this Command to stop running.
void	waitTillFinished() Blocks until the command has finished execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command()

Creates a new Command.

Method Detail

start

public void start()

Called to start the Command

waitTillFinished

public void waitTillFinished()

Blocks until the command has finished execution. Note that this method will not return until the onStop method has returned.

isRunning

public boolean isRunning()

Checks if this Command is currently running.

Returns:

If this Command is currently running.

stop

public void stop()

Forces this Command to stop running.

forceStop

public void forceStop()

onInit

public abstract void onInit()

Runs once every time this Command is started.

onLoop

public abstract void onLoop()

Runs continuously until isFinished returns true. Is not guaranteed to run.

onStop

public abstract void onStop()

Runs once when isFinished returns true and onLoop finishes.

isFinished

public abstract boolean isFinished()

User-implemented method to check if onLoop should stop executing.

Returns:

True when onLoop should onStop executing

run

public void run()

Manages the lifecycle of this Command

Specified by:

run in interface java.lang.Runnable