org.refcodes.assembler

Interface Assembler<WP>

Type Parameters:

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

WP - The work piece which is being passed to the implementing assembler and which is processed by the assembler.

WPE - A work piece exception in case processing of the work piece failed by one the implementing assembler.

All Known Implementing Classes:

CompositeSequentialAssemblerImpl

public interface Assembler<WP>

An assembler to manufacture a work piece object. This can be achieved within several steps. Then them steps each can be implemented by a dedicated assembler being invoked one after the other with a given work piece object. After invocation of the assemblers and after an assembler flagged completion of the work piece, then the work piece is considered to be finished. Assemblers might be arranged in a production line manner (one assembler is invoked after the other) or construction of the participating assemblers might by achieved using the composite pattern. Having the according implementations of e.g. sequential assemblers, then individual nested assembler structures may be constructed.

Method Summary

Modifier and Type	Method and Description
boolean	doAssemble(WP aWorkPiece) This method is invoked with a work as argument.

Method Detail

doAssemble

boolean doAssemble(WP aWorkPiece)
            throws WorkPieceException

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.

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.