dsto.dfc.swt.forms
Class PipeEndpoint

java.lang.Object
  extended by dsto.dfc.swt.forms.AbstractPipe
      extended by dsto.dfc.swt.forms.PipeEndpoint
All Implemented Interfaces:
Pipe, Disposable
Direct Known Subclasses:
ButtonEndpoint, NumberEndpoint, RadioEndpoint, TextEndpoint

public abstract class PipeEndpoint
extends AbstractPipe

Base class for pipe endpoints: pipe segments that put their input into a non-pipe (eg a UI control). Endpoints cannot have child pipes and cannot have values output () to them.

Author:
phillipm

Field Summary
 
Fields inherited from class dsto.dfc.swt.forms.AbstractPipe
errorHandler, parent
 
Constructor Summary
PipeEndpoint()
           
 
Method Summary
 Pipe connect(Pipe pipe)
          Connect the output of this pipe to the input of a child pipe.
abstract  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)).
abstract  boolean input(Object value)
          Input a value into the pipe tree.
 boolean output(Object value)
          Output a value from a child into the pipe (the reverse of input ()).
 
Methods inherited from class dsto.dfc.swt.forms.AbstractPipe
dispose, getParent, handlePipeError, setErrorHandler, 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
isDisposed
 

Constructor Detail

PipeEndpoint

public PipeEndpoint()
Method Detail

flush

public abstract 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.

Returns:
True if the operation completed successfully.
See Also:
for more info on handling errors.

input

public abstract boolean input(Object value)
Description copied from interface: Pipe
Input a value into the pipe tree.

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.


output

public boolean output(Object value)
Description copied from interface: Pipe
Output a value from a child into the pipe (the reverse of input ()).

Returns:
True if the operation completed successfully.
See Also:
for more info on handling errors.


Copyright © 2008 Commonwealth of Australia