org.apache.commons.pipeline.stage
Class KeyWaitBufferStage

java.lang.Object
  org.apache.commons.pipeline.stage.BaseStage
      org.apache.commons.pipeline.stage.KeyWaitBufferStage

All Implemented Interfaces:

EventListener, Stage, StageEventListener

public class KeyWaitBufferStage
extends BaseStage
implements StageEventListener

Author:

kjn

Field Summary

Fields inherited from class org.apache.commons.pipeline.stage.BaseStage

context

Constructor Summary

KeyWaitBufferStage()
Creates a new instance of KeyWaitBufferStage

Method Summary

KeyFactory<Object,? extends Object>	getKeyFactory() Getter for property keyFactory.
QueueFactory<Object>	getQueueFactory() Getter for property queueFactory.
void	init(StageContext context) This implementation of init() simply stores a reference to the stage context.
void	notify(EventObject ev) Notify this listener of a StageEvent
void	process(Object obj) The only operation performed by this implementation of process() is to feed the specified object to the downstream feeder.
void	setKeyFactory(KeyFactory<Object,? extends Object> keyFactory) Setter for property keyFactory.
void	setQueueFactory(QueueFactory<Object> queueFactory) Setter for property queueFactory.

Methods inherited from class org.apache.commons.pipeline.stage.BaseStage

emit, emit, postprocess, preprocess, release

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyWaitBufferStage

public KeyWaitBufferStage()

Creates a new instance of KeyWaitBufferStage

Method Detail

notify

public void notify(EventObject ev)

Description copied from interface: StageEventListener

Notify this listener of a StageEvent

Specified by:

notify in interface StageEventListener

Parameters:

ev - The event to be handled. Listeners should gracefully ignore any events that they do not know how to handle.

init

public void init(StageContext context)

Description copied from class: BaseStage

This implementation of init() simply stores a reference to the stage context.

Specified by:

init in interface Stage

Overrides:

init in class BaseStage

Parameters:

context - the StageContext within which the stage sill be run

process

public void process(Object obj)
             throws StageException

Description copied from class: BaseStage

The only operation performed by this implementation of process() is to feed the specified object to the downstream feeder. This method should be overridden to provide processing capability for the stage.

Specified by:

process in interface Stage

Overrides:

process in class BaseStage

Parameters:

obj - Object to be passed to downstream pipeline.

Throws:

StageException - an Exception thrown by an overriding implementation should be wrapped in a StageException

getKeyFactory

public KeyFactory<Object,? extends Object> getKeyFactory()

Getter for property keyFactory.

Returns:

Value of property keyFactory.

setKeyFactory

public void setKeyFactory(KeyFactory<Object,? extends Object> keyFactory)

Setter for property keyFactory.

Parameters:

keyFactory - New value of property keyFactory.

getQueueFactory

public QueueFactory<Object> getQueueFactory()

Getter for property queueFactory.

Returns:

Value of property queueFactory.

setQueueFactory

public void setQueueFactory(QueueFactory<Object> queueFactory)

Setter for property queueFactory.

Parameters:

queueFactory - New value of property queueFactory.