net.craftforge.essential.controller.phases.flow
Interface PhaseFlow

All Known Implementing Classes:

StandardPhaseFlow

public interface PhaseFlow

A phase flow defines with which phase a controller starts and which phase follows on another phase depending on the controller setup and state.

Since:

30.05.2011

Author:

Christian Bick

Method Summary

Phase	getFirstPhase() Gets the controller phase to start with
Phase	getPhaseAfter(Phase phase) Gets the controller phase which follows after the given phase.
void	setSetup(Setup setup) Sets the controller setup
void	setState(State state) Sets the controller state

Method Detail

setState

void setState(State state)

Sets the controller state

Parameters:

state - The controller state

setSetup

void setSetup(Setup setup)

Sets the controller setup

Parameters:

setup - The controller setup

getFirstPhase

Phase getFirstPhase()

Gets the controller phase to start with

Returns:

The controller phase to start with

getPhaseAfter

Phase getPhaseAfter(Phase phase)
                    throws ControllerException

Gets the controller phase which follows after the given phase.

Parameters:

phase - The phase to estimate the following phase for

Returns:

The following controller phase or null if no phase follows (last phase)

Throws:

ControllerException - if the input phase is not known by the phase flow