org.jcreme.processing
Class ProducerMultiplexer

java.lang.Object
  extended byorg.jcreme.processing.DefaultConsumer
      extended byorg.jcreme.processing.ProducerMultiplexer
All Implemented Interfaces:
Consumer

public class ProducerMultiplexer
extends DefaultConsumer

This class enables to multiply the output of a single producer so that it can be used in different production lines.

Author:
$Author: dbregeon $

Constructor Summary
ProducerMultiplexer(Producer provider)
          Creates a new instance of ProducerMultiplexer
 
Method Summary
 java.lang.Object consumeItem()
          Consumes a new item.
 java.lang.Object consumeItem(MultiplexedProducer producer)
          This method enables to consume the data associated to one of the Producers that are multiplexed.
 MultiplexedProducer getMultiplexedProducer()
          Provides a new MultiplexedProducer.
 void removeMultiplexedProducer(MultiplexedProducer producer)
          Unregisters a MultiplexedProducer from the Multiplexer.
 boolean validateItem(java.lang.Object theItem)
          Tells the parent producer that this consumer has finished with this object.
 
Methods inherited from class org.jcreme.processing.DefaultConsumer
getProvider, setProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProducerMultiplexer

public ProducerMultiplexer(Producer provider)
Creates a new instance of ProducerMultiplexer

Parameters:
provider - the Producer that provides values.
Method Detail

consumeItem

public java.lang.Object consumeItem()
Consumes a new item.

Specified by:
consumeItem in interface Consumer
Overrides:
consumeItem in class DefaultConsumer
Returns:
The object produced by the consumption of a new item.
See Also:
Consumer.consumeItem()

consumeItem

public java.lang.Object consumeItem(MultiplexedProducer producer)
This method enables to consume the data associated to one of the Producers that are multiplexed.

Parameters:
producer - the producer to feed.
Returns:
the item to feed to producer.

validateItem

public boolean validateItem(java.lang.Object theItem)
Description copied from class: DefaultConsumer
Tells the parent producer that this consumer has finished with this object.

Specified by:
validateItem in interface Consumer
Overrides:
validateItem in class DefaultConsumer
Parameters:
theItem - an item that was previously retrieved through the consumeItem method.
Returns:
true is item was successfully validated.
See Also:
Consumer.validateItem(Object)

getMultiplexedProducer

public MultiplexedProducer getMultiplexedProducer()
Provides a new MultiplexedProducer.

Returns:
a new empty MutliplexedProducer.

removeMultiplexedProducer

public void removeMultiplexedProducer(MultiplexedProducer producer)
Unregisters a MultiplexedProducer from the Multiplexer.

Parameters:
producer - the producer to remove.


Copyright 2006 null. All Rights Reserved.