io.engineblock.activityapi.core

Interface Activity

All Superinterfaces:

Comparable<Activity>

All Known Implementing Classes:

SimpleActivity

public interface Activity
extends Comparable<Activity>

Provides the components needed to build and run an activity a runtime. The easiest way to build a useful Activity is to extend SimpleActivity.

Method Summary

Modifier and Type	Method and Description
void	closeAutoCloseables() Close all autocloseables that have been registered with this Activity.
ActionDispenser	getActionDispenserDelegate()
ActivityDef	getActivityDef()
default String	getAlias()
default String	getCycleSummary()
InputDispenser	getInputDispenserDelegate()
OutputDispenser	getMarkerDispenserDelegate()
MotorDispenser	getMotorDispenserDelegate()
default ParameterMap	getParams()
IntPredicateDispenser	getResultFilterDispenserDelegate()
RunState	getRunState()
default void	initActivity()
void	registerAutoCloseable(AutoCloseable closeable) Register an object which should be closed after this activity is shutdown.
void	setActionDispenserDelegate(ActionDispenser actionDispenser)
void	setInputDispenserDelegate(InputDispenser inputDispenser)
void	setMotorDispenserDelegate(MotorDispenser motorDispenser)
void	setOutputDispenserDelegate(OutputDispenser outputDispenser)
void	setResultFilterDispenserDelegate(IntPredicateDispenser resultFilterDispenser)
void	setRunState(RunState runState)
default void	shutdownActivity()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

registerAutoCloseable

void registerAutoCloseable(AutoCloseable closeable)

Register an object which should be closed after this activity is shutdown.

Parameters:

closeable - An Autocloseable object

closeAutoCloseables

void closeAutoCloseables()

Close all autocloseables that have been registered with this Activity.

getMotorDispenserDelegate

MotorDispenser getMotorDispenserDelegate()

setMotorDispenserDelegate

void setMotorDispenserDelegate(MotorDispenser motorDispenser)

getInputDispenserDelegate

InputDispenser getInputDispenserDelegate()

setInputDispenserDelegate

void setInputDispenserDelegate(InputDispenser inputDispenser)

getActionDispenserDelegate

ActionDispenser getActionDispenserDelegate()

setActionDispenserDelegate

void setActionDispenserDelegate(ActionDispenser actionDispenser)

getResultFilterDispenserDelegate

IntPredicateDispenser getResultFilterDispenserDelegate()

setResultFilterDispenserDelegate

void setResultFilterDispenserDelegate(IntPredicateDispenser resultFilterDispenser)

getMarkerDispenserDelegate

OutputDispenser getMarkerDispenserDelegate()

setOutputDispenserDelegate

void setOutputDispenserDelegate(OutputDispenser outputDispenser)

getActivityDef

ActivityDef getActivityDef()

getAlias

default String getAlias()

getParams

default ParameterMap getParams()

initActivity

default void initActivity()

getRunState

RunState getRunState()

setRunState

void setRunState(RunState runState)

shutdownActivity

default void shutdownActivity()

getCycleSummary

default String getCycleSummary()