Package org.onehippo.forge.pageflow.core.rt.impl

Class DefaultPageFlow

java.lang.Object

org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow

All Implemented Interfaces:

Serializable, PageFlow

public class DefaultPageFlow
extends Object
implements PageFlow

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultPageFlow(String id, org.springframework.statemachine.StateMachine<PageState,String> stateMachine)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the specified object with this PageFlow for equality.
Object	getAttribute(String name)	Find and return the attribute model object of this PageFlow by the name.
Map<String,Object>	getAttributeMap()	Return an unmodifiable attributes map of this PageFlow.
String	getId()	Return the identifier of the PageFlow instance.
PageState	getPageState()	Return the current PageState instance in the PageFlow.
List<PageState>	getPageStates()	Return an unmodifiable list of the PageState of this PageFlow.
int	hashCode()	Returns the hash code value for this PageFlow.
boolean	isComplete()	Return true if this PageFlow instance is completed.
boolean	isStarted()	Return true if this PageFlow instance has started.
boolean	isStopped()	Return true if this PageFlow instance has stopped.
void	sendEvent(String event)	Send an event to the PageFlow, which might cause a Page Transition as a result.
void	setAttribute(String name, Object model)	Set the attribute by the name on this PageFlow.
void	start()	Start this PageFlow instance.
void	stop()	Stop this PageFlow instance.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultPageFlow

public DefaultPageFlow(String id,
                       org.springframework.statemachine.StateMachine<PageState,String> stateMachine)

Method Detail

getId

public String getId()

Description copied from interface: PageFlow

Return the identifier of the PageFlow instance.

Specified by:

getId in interface PageFlow

Returns:

the identifier of the PageFlow instance

isStarted

public boolean isStarted()

Description copied from interface: PageFlow

Return true if this PageFlow instance has started.

Specified by:

isStarted in interface PageFlow

Returns:

true if this PageFlow instance has started

start

public void start()
           throws PageFlowException

Description copied from interface: PageFlow

Start this PageFlow instance.

Specified by:

start in interface PageFlow

Throws:

PageFlowException - if it can't start

isStopped

public boolean isStopped()

Description copied from interface: PageFlow

Return true if this PageFlow instance has stopped.

Specified by:

isStopped in interface PageFlow

Returns:

true if this PageFlow instance has stopped

stop

public void stop()
          throws PageFlowException

Description copied from interface: PageFlow

Stop this PageFlow instance.

Specified by:

stop in interface PageFlow

Throws:

PageFlowException - if it can't stop

isComplete

public boolean isComplete()
                   throws PageFlowException

Description copied from interface: PageFlow

Return true if this PageFlow instance is completed.

Specified by:

isComplete in interface PageFlow

Returns:

true if this PageFlow instance is completed

Throws:

PageFlowException - if any exception occurs

getPageState

public PageState getPageState()
                       throws PageFlowException

Description copied from interface: PageFlow

Return the current PageState instance in the PageFlow.

Specified by:

getPageState in interface PageFlow

Returns:

the current PageState instance in the PageFlow

Throws:

PageFlowException - if any exception occurs

sendEvent

public void sendEvent(String event)
               throws PageFlowException

Description copied from interface: PageFlow

Send an event to the PageFlow, which might cause a Page Transition as a result.

Specified by:

sendEvent in interface PageFlow

Parameters:

event - event

Throws:

PageFlowException - if any exception occurs

getPageStates

public List<PageState> getPageStates()
                              throws PageFlowException

Description copied from interface: PageFlow

Return an unmodifiable list of the PageState of this PageFlow.

Specified by:

getPageStates in interface PageFlow

Returns:

an unmodifiable list of the PageState of this PageFlow

Throws:

PageFlowException - if any exception occurs

getAttribute

public Object getAttribute(String name)
                    throws PageFlowException

Description copied from interface: PageFlow

Find and return the attribute model object of this PageFlow by the name. Return null if not found.

Specified by:

getAttribute in interface PageFlow

Parameters:

name - attribute name

Returns:

the attribute model object of this PageFlow by the name, null if not found

Throws:

PageFlowException - if any exception occurs

setAttribute

public void setAttribute(String name,
                         Object model)
                  throws PageFlowException

Description copied from interface: PageFlow

Set the attribute by the name on this PageFlow.

Specified by:

setAttribute in interface PageFlow

Parameters:

name - attribute name

model - attribute model object

Throws:

PageFlowException - if any exception occurs

getAttributeMap

public Map<String,Object> getAttributeMap()
                                         throws PageFlowException

Description copied from interface: PageFlow

Return an unmodifiable attributes map of this PageFlow.

Specified by:

getAttributeMap in interface PageFlow

Returns:

an unmodifiable attributes map of this PageFlow

Throws:

PageFlowException - if any exception occurs

equals

public boolean equals(Object o)

Description copied from interface: PageFlow

Compares the specified object with this PageFlow for equality.

Specified by:

equals in interface PageFlow

Overrides:

equals in class Object

Parameters:

o - the object to be compared for equality with this PageFlow

Returns:

true if the specified object is equal to this PageFlow

hashCode

public int hashCode()

Description copied from interface: PageFlow

Returns the hash code value for this PageFlow.

Specified by:

hashCode in interface PageFlow

Overrides:

hashCode in class Object

Returns:

the hash code value for this PageFlow

toString

public String toString()

Overrides:

toString in class Object