org.specrunner.core.pipes
Class PipeDumper

java.lang.Object
  org.specrunner.core.pipes.PipeDumper

All Implemented Interfaces:

IPipe

public class PipeDumper
extends Object
implements IPipe

Adds a dumper to the channel.

Author:

Thiago Santos

Field Summary

static String

DUMPER Dumper.

Constructor Summary

PipeDumper()

Method Summary

static IChannel	bind(IChannel channel, ISourceDumper obj) Bind the object to the channel.
boolean	check(IChannel channel) Check if a pipe must perform something on channel.
protected ISourceDumper	createDumper() Creates an dumper instance.
static ISourceDumper	lookup(IChannel channel) Recover a dumper 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

DUMPER

public static final String DUMPER

Dumper.

See Also:

Constant Field Values

Constructor Detail

PipeDumper

public PipeDumper()

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.

createDumper

protected ISourceDumper createDumper()
                              throws SourceDumperException

Creates an dumper instance.

Returns:

A dumper.

Throws:

SourceDumperException - On creation error.

bind

public static IChannel bind(IChannel channel,
                            ISourceDumper obj)

Bind the object to the channel.

Parameters:

channel - The channel.

obj - The object.

Returns:

The channel itself.

lookup

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

Recover a dumper from channel.

Parameters:

channel - The channel.

Returns:

The dumper.

Throws:

NotFoundException - On lookup errors.

InvalidTypeException - On type errors.