net.officefloor.frame.impl.execute.job

Class JobSequenceImpl

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<JobSequence,ThreadState>

net.officefloor.frame.impl.execute.job.JobSequenceImpl

All Implemented Interfaces:

FlowFuture, FlowAsset, JobSequence, LinkedListSetEntry<JobSequence,ThreadState>

public class JobSequenceImpl
extends AbstractLinkedListSetEntry<JobSequence,ThreadState>
implements JobSequence

Implementation of the JobSequence.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
JobSequenceImpl(ThreadState threadState) Initiate.

Method Summary

Modifier and Type	Method and Description
JobNode	createGovernanceNode(GovernanceActivity<?,?> governanceActivity, JobNode parallelNodeOwner) Creates a new JobNode contained in this JobSequence for the GovernanceActivity.
JobNode	createTaskNode(TaskMetaData<?,?,?> taskMetaData, JobNode parallelNodeOwner, Object parameter, GovernanceDeactivationStrategy governanceDeactivationStrategy) Creates a new JobNode contained in this JobSequence for the Task.
ThreadState	getLinkedListSetOwner() Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
ThreadState	getThreadState() Obtains the ThreadState containing this JobSequence.
boolean	isComplete() Indicates whether the JobSequence has completed.
void	jobNodeComplete(JobNode jobNode, JobNodeActivateSet activateSet, TeamIdentifier currentTeam) Flags that the input JobNode has completed.
boolean	waitOnFlow(JobNode jobNode, long timeout, Object token, JobNodeActivateSet activateSet) Flags for the input JobNode to wait on this JobSequence.

Methods inherited from class net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry

getNext, getPrev, setNext, setPrev

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.internal.structure.LinkedListSetEntry

getNext, getPrev, setNext, setPrev

Constructor Detail

JobSequenceImpl

public JobSequenceImpl(ThreadState threadState)

Initiate.

Parameters:

threadState - ThreadState containing this JobSequence.

Method Detail

getLinkedListSetOwner

public ThreadState getLinkedListSetOwner()

Description copied from interface: LinkedListSetEntry

Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.

LinkedListSetEntry instances may only be added to the LinkedListSet they were intended for and can not be shared between LinkedListSet instances. This constraint:

1. ensures the integrity of the JobNode, JobSequence, ThreadState, ProcessState structure, and
2. improves uniqueness performance as LinkedListSetEntry.getNext() and LinkedListSetEntry.getPrev() both returning null indicates not added

Specified by:

getLinkedListSetOwner in interface LinkedListSetEntry<JobSequence,ThreadState>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

createTaskNode

public JobNode createTaskNode(TaskMetaData<?,?,?> taskMetaData,
                              JobNode parallelNodeOwner,
                              Object parameter,
                              GovernanceDeactivationStrategy governanceDeactivationStrategy)

Description copied from interface: JobSequence

Creates a new JobNode contained in this JobSequence for the Task.

Specified by:

createTaskNode in interface JobSequence

Parameters:

taskMetaData - TaskMetaData for the new JobNode.

parallelNodeOwner - JobNode that is the parallel owner of the new JobNode.

parameter - Parameter for the JobNode.

governanceDeactivationStrategy - GovernanceDeactivationStrategy.

Returns:

New JobNode.

createGovernanceNode

public JobNode createGovernanceNode(GovernanceActivity<?,?> governanceActivity,
                                    JobNode parallelNodeOwner)

Description copied from interface: JobSequence

Creates a new JobNode contained in this JobSequence for the GovernanceActivity.

Specified by:

createGovernanceNode in interface JobSequence

Parameters:

governanceActivity - GovernanceActivity.

parallelNodeOwner - JobNode that is the parallel owner of the new JobNode.

Returns:

New JobNode.

jobNodeComplete

public void jobNodeComplete(JobNode jobNode,
                            JobNodeActivateSet activateSet,
                            TeamIdentifier currentTeam)

Description copied from interface: JobSequence

Flags that the input JobNode has completed.

Specified by:

jobNodeComplete in interface JobSequence

Parameters:

jobNode - JobNode that has completed.

activateSet - JobNodeActivateSet to add JobNode instances waiting on this JobSequence if all JobNode instances of this JobSequence are complete.

currentTeam - TeamIdentifier of the current Team completing the JobNode.

getThreadState

public ThreadState getThreadState()

Description copied from interface: JobSequence

Obtains the ThreadState containing this JobSequence.

Specified by:

getThreadState in interface JobSequence

Returns:

ThreadState containing this JobSequence.

isComplete

public boolean isComplete()

Description copied from interface: FlowFuture

Indicates whether the JobSequence has completed.

Specified by:

isComplete in interface FlowFuture

Returns:

true if the JobSequence has completed.

waitOnFlow

public boolean waitOnFlow(JobNode jobNode,
                          long timeout,
                          Object token,
                          JobNodeActivateSet activateSet)

Description copied from interface: FlowAsset

Flags for the input JobNode to wait on this JobSequence.

Note that the JobNode may not wait on a JobSequence contained in the same ThreadState as that of the JobNode. This would result on the ThreadState waiting on itself and subsequently no progression of the ThreadState.

Specified by:

waitOnFlow in interface FlowAsset

Parameters:

jobNode - JobNode to wait on this JobSequence.

timeout - The maximum time to wait in milliseconds for the JobSequence to complete.

token - A token added to the FlowJoinTimedOutEscalation to aid in identifying which JobSequence join timed out. May be null.

activateSet - JobNodeActivateSet to activate the JobNode instances should JobSequence be completed.

Returns:

true if waiting on this JobSequence, otherwise false if JobSequence has already completed and not waiting.