dsto.dfc.swt.forms
Class MultiPipe

java.lang.Object
  dsto.dfc.swt.forms.AbstractPipe
      dsto.dfc.swt.forms.MultiPipe

All Implemented Interfaces:

Pipe, Disposable

public class MultiPipe
extends AbstractPipe
implements Pipe

A multiplex pipe that outputs its input to a list of children.

Version:

$Revision$

Author:

mpp

Field Summary

Fields inherited from class dsto.dfc.swt.forms.AbstractPipe

errorHandler, parent

Constructor Summary

MultiPipe()
Constructor for MultiPipe.

Method Summary

Pipe	connect(Pipe pipe) Connect the output of this pipe to the input of a child pipe.
void	dispose() Default implementation: does nothing.
boolean	flush() Cause any uncommitted changes to any pipe segments in the tree to be pushed back into the pipe sequence (using Pipe.output(Object)).
boolean	input(Object value) Input a value into the pipe tree.
boolean	isDisposed() Test if pipe has been disposed.
boolean	output(Object value) Output a value from a child into the pipe (the reverse of input ()).
void	setErrorHandler(PipeErrorHandler handler) Set the handler for any errors encountered while loading/unloading the pipe.

Methods inherited from class dsto.dfc.swt.forms.AbstractPipe

getParent, handlePipeError, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface dsto.dfc.swt.forms.Pipe

getParent, setParent

Constructor Detail

MultiPipe

public MultiPipe()

Constructor for MultiPipe.

Method Detail

dispose

public void dispose()

Description copied from class: AbstractPipe

Default implementation: does nothing.

Specified by:

dispose in interface Pipe

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractPipe

isDisposed

public boolean isDisposed()

Description copied from interface: Pipe

Test if pipe has been disposed.

Specified by:

isDisposed in interface Pipe

input

public boolean input(Object value)

Description copied from interface: Pipe

Input a value into the pipe tree.

Specified by:

input in interface Pipe

Returns:

True if the operation completed successfully.

See Also:

for more info on handling errors.

output

public boolean output(Object value)

Description copied from interface: Pipe

Output a value from a child into the pipe (the reverse of input ()).

Specified by:

output in interface Pipe

Returns:

True if the operation completed successfully.

See Also:

for more info on handling errors.

flush

public boolean flush()

Description copied from interface: Pipe

Cause any uncommitted changes to any pipe segments in the tree to be pushed back into the pipe sequence (using Pipe.output(Object)). This is designed for use by pipes connect editors such as text fields that are not committed immediately: most pipes will simply forward this call on to their children.

Specified by:

flush in interface Pipe

Returns:

True if the operation completed successfully.

See Also:

for more info on handling errors.

connect

public Pipe connect(Pipe pipe)

Description copied from interface: Pipe

Connect the output of this pipe to the input of a child pipe.

Specified by:

connect in interface Pipe

setErrorHandler

public void setErrorHandler(PipeErrorHandler handler)

Description copied from interface: Pipe

Set the handler for any errors encountered while loading/unloading the pipe. This will also set the handler for all children.

Specified by:

setErrorHandler in interface Pipe

Overrides:

setErrorHandler in class AbstractPipe

See Also:

PipeErrorHandler