teetime.framework.pipe

Class ReflexivePipe<T>

java.lang.Object

teetime.framework.AbstractPipe<T>

teetime.framework.pipe.AbstractUnsynchedPipe<T>

teetime.framework.pipe.ReflexivePipe<T>

Type Parameters:

T - the type of the elements which this pipe should transfer.

All Implemented Interfaces:

IPipe<T>

public class ReflexivePipe<T>
extends AbstractUnsynchedPipe<T>

Represents an unsynchronized pipe with a capacity of 1. In contrast to the UnsynchedPipe, this pipe does not execute its successor stage if an element has been added. This pipe has only rare application scenarios. Its main purpose is to connect an output port and an input port of the same stage.

Author:

Christian Wulf (chw)

Field Summary

Fields inherited from class teetime.framework.AbstractPipe

cachedTargetStage

Constructor Summary

Constructors

Constructor and Description
ReflexivePipe(OutputPort<? extends T> sourcePort, InputPort<T> targetPort)

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()
boolean	isEmpty() Checks whether the pipe is empty or not.
Object	removeLast() Retrieves and removes the last element from the pipe.
int	size()

Methods inherited from class teetime.framework.pipe.AbstractUnsynchedPipe

close, isClosed, reportNewElement, sendSignal, waitForStartSignal

Methods inherited from class teetime.framework.AbstractPipe

getCachedTargetStage, getScheduler, getSourcePort, getTargetPort, hasMore, setScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflexivePipe

public ReflexivePipe(OutputPort<? extends T> sourcePort,
                     InputPort<T> targetPort)

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.

Parameters:

element - to be added

addNonBlocking

public boolean addNonBlocking(Object element)

Description copied from interface: IPipe

Adds an element to the pipe.

Parameters:

element - Element which will be added

Returns:

true if the element could be added, false otherwise

isEmpty

public boolean isEmpty()

Description copied from interface: IPipe

Checks whether the pipe is empty or not.

Returns:

true if the pipe is empty, false otherwise.

size

public int size()

Returns:

the current number of elements held by this pipe instance

removeLast

public Object removeLast()

Description copied from interface: IPipe

Retrieves and removes the last element from the pipe.

Returns:

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

capacity

public int capacity()

Returns:

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