org.refcodes.assembler.impls

Class CompositeSequentialAssemblerImpl<WP>

java.lang.Object

org.refcodes.assembler.impls.CompositeSequentialAssemblerImpl<WP>

Type Parameters:

CTX - The context passed to each contained assembler upon initialization.

IE - An initialize exception in case initializing of an assembler failed.

WP - The work piece which is being passed to the contained assemblers one after the other and which is processed by the assemblers.

WPE - A work piece exception in case processing of the work piece failed by one of the contained assemblers.

All Implemented Interfaces:

Flushable, Assembler<WP>, Closable, CompositeComponent, Decomposeable, Destroyable, DeviceComponent, Initializable, LifeCycleComponent, Openable, Pausable, Resetable, Resumable, Startable, Stoppable, org.refcodes.mixin.Disposable

public class CompositeSequentialAssemblerImpl<WP>
extends Object
implements Assembler<WP>, CompositeComponent

A compound sequential assembler which is passing the work piece from one contained assembler to the next in the order in which them were passed. In case any of the contained assemblers returns flags the processing of the work piece to be "finished" (in its doAssemble(Object) method it returns true), then this compound sequential assembler returns true.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.CompositeComponent

CompositeComponent.ExtendedCompositeComponent<CTX,CON>

Nested classes/interfaces inherited from interface org.refcodes.component.LifeCycleComponent

LifeCycleComponent.LifeCycleAutomaton, LifeCycleComponent.UncheckedLifeCycleComponent

Nested classes/interfaces inherited from interface org.refcodes.component.Initializable

Initializable.InitializeAutomaton, Initializable.InitializeBuilder<B extends Initializable.InitializeBuilder<B>>, Initializable.UncheckedInitializable

Nested classes/interfaces inherited from interface org.refcodes.component.Startable

Startable.StartAutomaton, Startable.StartBuilder<B extends Startable.StartBuilder<B>>, Startable.UncheckedStartable

Nested classes/interfaces inherited from interface org.refcodes.component.Pausable

Pausable.PauseAutomaton, Pausable.PauseBuilder<B extends Pausable.PauseBuilder<B>>, Pausable.UncheckedPausable

Nested classes/interfaces inherited from interface org.refcodes.component.Resumable

Resumable.ResumeAutomaton, Resumable.ResumeBuilder<B extends Resumable.ResumeBuilder<B>>, Resumable.UncheckedResumable

Nested classes/interfaces inherited from interface org.refcodes.component.Stoppable

Stoppable.StopAutomaton, Stoppable.StopBuilder<B extends Stoppable.StopBuilder<B>>, Stoppable.UncheckedStoppable

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.DeviceComponent

DeviceComponent.DeviceAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.Openable

Openable.OpenAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

Closable.CloseAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.Decomposeable

Decomposeable.DecomposeAutomaton

Nested classes/interfaces inherited from interface org.refcodes.mixin.Disposable

org.refcodes.mixin.Disposable.DisposeSupport

Constructor Summary

Constructors

Constructor and Description
CompositeSequentialAssemblerImpl(Assembler<WP>... aAssemblers) Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object).
CompositeSequentialAssemblerImpl(boolean isContinueOnFinished, boolean isContinueOnError, Assembler<WP>... aAssemblers) Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object).
CompositeSequentialAssemblerImpl(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy, Assembler<WP>... aAssemblers) Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object).
CompositeSequentialAssemblerImpl(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy, boolean isContinueOnFinished, boolean isContinueOnError, Assembler<WP>... aAssemblers) Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object).

Method Summary

Modifier and Type	Method and Description
void	close()
void	decompose()
void	destroy()
void	dispose()
boolean	doAssemble(WP aWorkPiece) This method is invoked with a work as argument.
void	flush()
void	initialize()
void	open()
void	pause()
void	reset()
void	resume()
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeSequentialAssemblerImpl

@SafeVarargs
public CompositeSequentialAssemblerImpl(Assembler<WP>... aAssemblers)

Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object).

Parameters:

aAssemblers - The assemblers to be invoked by the compound sequential assembler.

CompositeSequentialAssemblerImpl

@SafeVarargs
public CompositeSequentialAssemblerImpl(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy,
                                                     Assembler<WP>... aAssemblers)

Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object).

Parameters:

aComponentExecutionStrategy - The strategy on how to invoke the state change requests (as of the CompositeComponent) defined methods) on the herein contained Component instances. CAUTION: The strategy does not affect on how the doAssemble(Object) methods of the herein contained instances are invoked.

aAssemblers - The assemblers to be invoked by the compound sequential assembler.

CompositeSequentialAssemblerImpl

@SafeVarargs
public CompositeSequentialAssemblerImpl(boolean isContinueOnFinished,
                                                     boolean isContinueOnError,
                                                     Assembler<WP>... aAssemblers)

Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object). The sequential assembler can be configured to continue the processing sequence even in case a WorkPieceException was thrown or even if a containing assembler signaled "finished" after processing the work piece (by returning true" after invocation of the method doAssemble(Object) ).

Parameters:

isContinueOnFinished - True in case all subsequent assemblers are to be processed even if an assembler signaled "finished" after processing the work piece.

isContinueOnError - True in case all subsequent assemblers are to be processed even if an assembler signaled an error after processing the work piece (by throwing an WorkPieceException).

aAssemblers - The assemblers to be invoked by the compound sequential assembler.

CompositeSequentialAssemblerImpl

@SafeVarargs
public CompositeSequentialAssemblerImpl(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy,
                                                     boolean isContinueOnFinished,
                                                     boolean isContinueOnError,
                                                     Assembler<WP>... aAssemblers)

Constructs the sequential assembler which contains a list of assemblers being invoked in the order in which them were added upon calling the method doAssemble(Object). The sequential assembler can be configured to continue the processing sequence even in case a WorkPieceException was thrown or even if a containing assembler signaled "finished" after processing the work piece (by returning true" after invocation of the method doAssemble(Object) ).

Parameters:

aComponentExecutionStrategy - The strategy on how to invoke the state change requests (as of the CompositeComponent) defined methods) on the herein contained Component instances. CAUTION: The strategy does not affect on how the doAssemble(Object) methods of the herein contained instances are invoked.

isContinueOnFinished - True in case all subsequent assemblers are to be processed even if an assembler signaled "finished" after processing the work piece.

isContinueOnError - True in case all subsequent assemblers are to be processed even if an assembler signaled an error after processing the work piece (by throwing an WorkPieceException).

aAssemblers - The assemblers to be invoked by the compound sequential assembler.

Method Detail

doAssemble

public boolean doAssemble(WP aWorkPiece)
                   throws WorkPieceException

Description copied from interface: Assembler

This method is invoked with a work as argument. The method processes the work piece in order to finish the work piece. In case the assembler is able to finish the the work piece then this is indicated by returning true. In case false is returned, then the work piece is considered not to be finished.

Specified by:

doAssemble in interface Assembler<WP>

Parameters:

aWorkPiece - The work piece which is to be processed by the assembler.

Returns:

True in case the assembler managed to "finish" the work piece. In such a case subsequent assemblers may not be required to be invoked. In such a case the assembler signals "finished". In case the assembler did not finish the work piece or is unsure whether the work piece is finished, then false is returned.

Throws:

WorkPieceException - In case the assembler was not able to work with the provided work piece, then an according work piece exception is thrown.

initialize

public void initialize()
                throws InitializeException

Specified by:

initialize in interface Initializable

Throws:

InitializeException

start

public void start()
           throws StartException

Specified by:

start in interface Startable

Throws:

StartException

pause

public void pause()
           throws PauseException

Specified by:

pause in interface Pausable

Throws:

PauseException

resume

public void resume()
            throws ResumeException

Specified by:

resume in interface Resumable

Throws:

ResumeException

stop

public void stop()
          throws StopException

Specified by:

stop in interface Stoppable

Throws:

StopException

decompose

public void decompose()

Specified by:

decompose in interface Decomposeable

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

reset

public void reset()

Specified by:

reset in interface Resetable

open

public void open()
          throws OpenException

Specified by:

open in interface Openable

Throws:

OpenException

close

public void close()

Specified by:

close in interface Closable

dispose

public void dispose()

Specified by:

dispose in interface org.refcodes.mixin.Disposable