teetime.framework.pipe

Class DummyPipe

java.lang.Object

teetime.framework.pipe.DummyPipe

All Implemented Interfaces:

IPipe<Object>

public final class DummyPipe
extends Object
implements IPipe<Object>

A pipe implementation used to connect unconnected output ports.

Author:

Christian Wulf

Field Summary

Fields

Modifier and Type	Field and Description
static IPipe<?>	INSTANCE

Method Summary

Modifier and Type	Method and Description
void	add(Object element) Adds an element to the pipe.
boolean	addNonBlocking(Object element) Adds an element to the pipe.
int	capacity()
void	close() May only be invoked by the input port and the owning (target) stage.
OutputPort<? extends Object>	getSourcePort()
InputPort<Object>	getTargetPort()
boolean	hasMore()
boolean	isClosed()
boolean	isEmpty() Checks whether the pipe is empty or not.
Object	removeLast() Retrieves and removes the last element from the pipe.
void	reportNewElement() Stages report new elements with this method.
void	sendSignal(ISignal signal) A stage can pass on a signal by executing this method.
void	setScheduler(PipeScheduler scheduler)
int	size()
void	waitForStartSignal()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final IPipe<?> INSTANCE

Method Detail

add

public void add(Object element)

Description copied from interface: IPipe

Adds an element to the pipe. This method does not return anything because it should guarantee element delivery (as opposed to IPipe.addNonBlocking(Object)). If it cannot guarantee element delivery in some special situation, it then must throw an exception.

Specified by:

add in interface IPipe<Object>

Parameters:

element - to be added

addNonBlocking

public boolean addNonBlocking(Object element)

Description copied from interface: IPipe

Adds an element to the pipe.

Specified by:

addNonBlocking in interface IPipe<Object>

Parameters:

element - Element which will be added

Returns:

true if the element could be added, false otherwise

removeLast

public Object removeLast()

Description copied from interface: IPipe

Retrieves and removes the last element from the pipe.

Specified by:

removeLast in interface IPipe<Object>

Returns:

the last element from the pipe, or null if the pipe is currently empty.

isEmpty

public boolean isEmpty()

Description copied from interface: IPipe

Checks whether the pipe is empty or not.

Specified by:

isEmpty in interface IPipe<Object>

Returns:

true if the pipe is empty, false otherwise.

size

public int size()

Specified by:

size in interface IPipe<Object>

Returns:

the current number of elements held by this pipe instance

getSourcePort

public OutputPort<? extends Object> getSourcePort()

Specified by:

getSourcePort in interface IPipe<Object>

Returns:

the output port that is connected to the pipe.

getTargetPort

public InputPort<Object> getTargetPort()

Specified by:

getTargetPort in interface IPipe<Object>

Returns:

the input port that is connected to the pipe.

sendSignal

public void sendSignal(ISignal signal)

Description copied from interface: IPipe

A stage can pass on a signal by executing this method. The signal will be sent to the receiving stage.

Specified by:

sendSignal in interface IPipe<Object>

Parameters:

signal - The signal which needs to be passed on.

reportNewElement

public void reportNewElement()

Description copied from interface: IPipe

Stages report new elements with this method.

Specified by:

reportNewElement in interface IPipe<Object>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface IPipe<Object>

Returns:

true if the pipe is closed, that is, if the pipe is empty and if the source stage will not send any elements anymore (because the stage has finished its whole work); returns false in all other cases.

hasMore

public boolean hasMore()

Specified by:

hasMore in interface IPipe<Object>

Returns:

true if the pipe is not empty, that is, if the pipe contains at least one element.

waitForStartSignal

public void waitForStartSignal()
                        throws InterruptedException

Specified by:

waitForStartSignal in interface IPipe<Object>

Throws:

InterruptedException

close

public void close()

Description copied from interface: IPipe

May only be invoked by the input port and the owning (target) stage.

Specified by:

close in interface IPipe<Object>

capacity

public int capacity()

Specified by:

capacity in interface IPipe<Object>

Returns:

the maximum number of elements possible to hold by this pipe instance

setScheduler

public void setScheduler(PipeScheduler scheduler)

Specified by:

setScheduler in interface IPipe<Object>