edu.berkeley.guir.lib.io
Class Filter

java.lang.Object
  |
  +--edu.berkeley.guir.lib.io.Filter

Direct Known Subclasses:

CharacterFilter, DebugFilter

public abstract class Filter

extends Object

Used by class Pipe to filter byte data.

This software is distributed under the Berkeley Software License.

 Revisions:  - GUIRLib-v1.0-1.0.0, Jun 16 1998, JH
               Created class
             - GUIRLib-v1.2-1.0.0, Jun 22 2000, JH
               Touched for GUIRLib release
             - GUIRLib-v1.3-1.0.0, Aug 11 2000, JH
               Touched for GUIRLib release
             - GUIRLib-v1.4-1.0.0, Aug 31 2000, JH
               Touched for GUIRLib release
 

Since:

JDK 1.1.6

Version:

GUIRLib-v1.4-1.0.0, Aug 31 2000

Author:

Jason Hong ( jasonh@cs.berkeley.edu )

Constructor Summary

Filter()

Method Summary

abstract void	filter(DataBuffer databuf) Filters the information in a pipe.
void	onFinishStream() Called when a stream of data is finished.
void	onStartStream() Called when a new stream of data is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

onStartStream

public void onStartStream()

Called when a new stream of data is started.

filter

public abstract void filter(DataBuffer databuf)

Filters the information in a pipe.

Parameters:

databuf - contains the data to filter.

Returns:

the length of the data in buffer ( <= length of buffer).

onFinishStream

public void onFinishStream()

Called when a stream of data is finished.