org.specrunner.pipeline
Interface IPipe

All Known Subinterfaces:

IPipeline

All Known Implementing Classes:

AbstractPipeModel, PipeAnnotate, PipeAnnotator, PipeContext, PipeDump, PipeDumper, PipeFeatureManager, PipelineImpl, PipeListenerManager, PipeMemory, PipeMetavariables, PipeModel, PipePopulator, PipeReport, PipeReporter, PipeResult, PipeResume, PipeReusable, PipeRun, PipeRun, PipeRunner, PipeShortDump, PipeSource, PipeTime, PipeTimestamp, PipeTransformSource

public interface IPipe

Stand for a stage (pipe) in a pipeline process.

Author:

Thiago Santos

Method Summary

boolean	check(IChannel channel) Check if a pipe must perform something on channel.
IChannel	process(IChannel channel) Perform some transformation over the channel.

Method Detail

check

boolean check(IChannel channel)
              throws AbortException

Check if a pipe must perform something on channel. If the channel is corrupted the pipe must throw AbortException.

Parameters:

channel - The information channel.

Returns:

true, if pipe must perform something on channel, false, otherwise.

Throws:

AbortException - If the channel is corrupted.

process

IChannel process(IChannel channel)
                 throws AbortException,
                        PipelineException

Perform some transformation over the channel.

Parameters:

channel - The channel.

Returns:

The pipe itself.

Throws:

AbortException - On processing errors.

PipelineException - On processing errors.