net.craftforge.essential.controller.phases.flow
Class StandardPhaseFlow

java.lang.Object
  net.craftforge.essential.controller.phases.flow.StandardPhaseFlow

All Implemented Interfaces:

PhaseFlow

public class StandardPhaseFlow
extends Object
implements PhaseFlow

The standard phase flow defines a default flow for phases.

Since:

30.05.2011

Author:

Christian Bick

Constructor Summary

StandardPhaseFlow()

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.
protected Phase	getPhaseAfterAllocation() Gets the phase following an allocation phase.
protected Phase	getPhaseAfterAuthentication() Gets the phase following an authentication phase.
protected Phase	getPhaseAfterDocumentation() Gets the phase following a documentation phase.
protected Phase	getPhaseAfterInvocation() Gets the phase following an invocation phase.
protected Phase	getPhaseAfterProduction() Gets the phase following a production phase.
void	setSetup(Setup setup) Sets the controller setup
void	setState(State state) Sets the controller state

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardPhaseFlow

public StandardPhaseFlow()

Method Detail

setState

public void setState(State state)

Sets the controller state

Specified by:

setState in interface PhaseFlow

Parameters:

state - The controller state

setSetup

public void setSetup(Setup setup)

Sets the controller setup

Specified by:

setSetup in interface PhaseFlow

Parameters:

setup - The controller setup

getFirstPhase

public Phase getFirstPhase()

Gets the controller phase to start with

Specified by:

getFirstPhase in interface PhaseFlow

Returns:

The controller phase to start with

getPhaseAfter

public Phase getPhaseAfter(Phase phase)
                    throws ControllerException

Gets the controller phase which follows after the given phase.

Specified by:

getPhaseAfter in interface PhaseFlow

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

getPhaseAfterAllocation

protected Phase getPhaseAfterAllocation()

Gets the phase following an allocation phase.

Returns:

The phase following an allocation phase

getPhaseAfterAuthentication

protected Phase getPhaseAfterAuthentication()

Gets the phase following an authentication phase.

Returns:

The phase following an authentication phase

getPhaseAfterInvocation

protected Phase getPhaseAfterInvocation()

Gets the phase following an invocation phase.

Returns:

The phase following an invocation phase

getPhaseAfterDocumentation

protected Phase getPhaseAfterDocumentation()

Gets the phase following a documentation phase.

Returns:

The phase following a documentation phase

getPhaseAfterProduction

protected Phase getPhaseAfterProduction()

Gets the phase following a production phase.

Returns:

The phase following a production phase