org.specrunner.core.pipes

Class PipeRunner

java.lang.Object

org.specrunner.core.pipes.PipeRunner

All Implemented Interfaces:

IPipe

public class PipeRunner
extends Object
implements IPipe

Add a runner to the pipe.

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
static String	RUNNER Source.

Constructor Summary

Constructors

Constructor and Description
PipeRunner()

Method Summary

Methods

Modifier and Type	Method and Description
static IChannel	bind(IChannel channel, IRunner obj) Bind the object to the channel.
boolean	check(IChannel channel) Check if a pipe must perform something on channel.
protected IRunner	createRunner(ISource source) Creates a runner for a source.
static IRunner	lookup(IChannel channel) Recover a runner from channel.
IChannel	process(IChannel channel) Perform some transformation over the channel.

Methods inherited from class java.lang.Object

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

Field Detail

RUNNER

public static final String RUNNER

Source.

See Also:

Constant Field Values

Constructor Detail

PipeRunner

public PipeRunner()

Method Detail

check

public boolean check(IChannel channel)
              throws AbortException

Description copied from interface: IPipe

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

Specified by:

check in interface IPipe

Parameters:

channel - The information channel.

Returns:

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

Throws:

AbortException - If the channel is corrupted.

process

public IChannel process(IChannel channel)
                 throws PipelineException

Description copied from interface: IPipe

Perform some transformation over the channel.

Specified by:

process in interface IPipe

Parameters:

channel - The channel.

Returns:

The pipe itself.

Throws:

PipelineException - On processing errors.

createRunner

protected IRunner createRunner(ISource source)
                        throws RunnerException

Creates a runner for a source.

Parameters:

source - The source.

Returns:

The corresponding runner.

Throws:

RunnerException - On creation errors.

bind

public static IChannel bind(IChannel channel,
            IRunner obj)

Bind the object to the channel.

Parameters:

channel - The channel.

obj - The object.

Returns:

The channel itself.

lookup

public static IRunner lookup(IChannel channel)
                      throws NotFoundException,
                             InvalidTypeException

Recover a runner from channel.

Parameters:

channel - The channel.

Returns:

The runner.

Throws:

NotFoundException - On lookup errors.

InvalidTypeException - On type erros.