net.wimpi.text
Interface ProcessingPipe

All Superinterfaces:

Processor

All Known Implementing Classes:

ProcessingPipeImpl

public interface ProcessingPipe

extends Processor

Interface that defines a processing pipe. Note that it extends the Processor interface, so it can be used exactly like a processor.

Version:

0.2 19/11/2002

Author:

Dieter Wimberger

See Also:

Processor

Method Summary

void	addProcessor(int pos, Processor proc) Adds a processor to this processing pipe, at a given position.
void	addProcessor(Processor proc) Adds a processor to this processing pipe.
void	flush() Removes all processors from this processing pipe.
boolean	isEmpty() Tests if the pipe is empty.
void	removeProcessor(int pos) Removes the processor at the given position from this processing pipe.
int	size() Returns the count of all processors in this pipe.

Methods inherited from interface net.wimpi.text.Processor

getDescription, getDescription, getName, listAvailableLocales, process, process, setDefaultLocale, setDescription

Method Detail

addProcessor

public void addProcessor(Processor proc)

Adds a processor to this processing pipe.

Parameters:

proc - the Processor instance to be added to this processing pipe.

See Also:

Processor

addProcessor

public void addProcessor(int pos,
                         Processor proc)
                  throws java.lang.IndexOutOfBoundsException

Adds a processor to this processing pipe, at a given position.

Parameters:

pos - the position where the given Processor instance should be added as int.

proc - the Processor instance to be added to this processing pipe.

See Also:

Processor

removeProcessor

public void removeProcessor(int pos)
                     throws java.lang.IndexOutOfBoundsException

Removes the processor at the given position from this processing pipe.

Parameters:

pos - the position of the Processor to be removed from this processing pipe.

flush

public void flush()

Removes all processors from this processing pipe.

isEmpty

public boolean isEmpty()

Tests if the pipe is empty. A pipe is empty if it does not contain any processor.

Returns:

true if this processing pipe is empty, false otherwise.

size

public int size()

Returns the count of all processors in this pipe. Note that contained processing pipes will be counted as single unit.

Returns:

the count of processors in this processing pipe as int.