org.specrunner.core.pipes

Class PipeReporter

java.lang.Object

org.specrunner.core.pipes.PipeReporter

All Implemented Interfaces:

IPipe

public class PipeReporter
extends Object
implements IPipe

Creates a reporter and add to the channel.

Author:

Thiago Santos

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPORTER Source.

Constructor Summary

Constructors

Constructor and Description
PipeReporter()

Method Summary

Methods

Modifier and Type	Method and Description
static IChannel	bind(IChannel channel, IReporter obj) Bind the object to the channel.
boolean	check(IChannel channel) Check if a pipe must perform something on channel.
protected IReporter	createReporter() Creates a reporter instance.
static IReporter	lookup(IChannel channel) Recover the reporter 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

REPORTER

public static final String REPORTER

Source.

See Also:

Constant Field Values

Constructor Detail

PipeReporter

public PipeReporter()

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.

createReporter

protected IReporter createReporter()
                            throws SourceDumperException

Creates a reporter instance.

Returns:

A reporter.

Throws:

SourceDumperException - On creation error.

bind

public static IChannel bind(IChannel channel,
            IReporter obj)

Bind the object to the channel.

Parameters:

channel - The channel.

obj - The object.

Returns:

The channel itself.

lookup

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

Recover the reporter from channel.

Parameters:

channel - The channel.

Returns:

The reporter.

Throws:

NotFoundException - On lookup errors.

InvalidTypeException - On type errors.