org.oddjob.beanbus.destinations

Class BusCollect<T>

java.lang.Object

org.oddjob.beanbus.AbstractFilter<T,T>

org.oddjob.beanbus.destinations.BusCollect<T>

Type Parameters:

T - The type of the beans to be collected.

All Implemented Interfaces:

java.util.function.Consumer<T>, BusFilter<T,T>, Outbound<T>, Service, Resettable, Stoppable

public class BusCollect<T>
extends AbstractFilter<T,T>
implements Resettable, Service

Description

A component that collects beans in a list. Additionally, this component may be used in the middle of a BasicBusService so can act as a Wire Tap.

Example

There are many examples elsewhere.

• Batcher
• BeanCopy
• BusQueue
• BusLimit

Author:

rob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusCollect.Conversions
static class	BusCollect.ListContainer<E>
static class	BusCollect.MapContainer<K,E>

Constructor Summary

Constructors

Constructor and Description
BusCollect()

Method Summary

Modifier and Type	Method and Description
protected T	filter(T from)
BusCollect.ListContainer<T>	getBeans()
int	getCount()
java.util.function.Function<? super T,java.lang.Object>	getKeyMapper()
BusCollect.ListContainer<T>	getList()
BusCollect.MapContainer<java.lang.Object,java.lang.Object>	getMap()
java.io.OutputStream	getOutput()
java.util.function.Function<? super T,java.lang.Object>	getValueMapper()
boolean	hardReset() Perform a hard reset.
void	setKeyMapper(java.util.function.Function<? super T,java.lang.Object> keyMapper)
void	setOutput(java.io.OutputStream output)
void	setValueMapper(java.util.function.Function<? super T,java.lang.Object> valueMapper)
boolean	softReset() Perform a soft reset.
void	start() Start the service.
void	stop() Stop executing.

Methods inherited from class org.oddjob.beanbus.AbstractFilter

accept, getName, getTo, setName, setTo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

BusCollect

public BusCollect()

Method Detail

softReset

public boolean softReset()

Description copied from interface: Resettable

Perform a soft reset.

Specified by:

softReset in interface Resettable

Returns:

true if successful.

hardReset

public boolean hardReset()

Description copied from interface: Resettable

Perform a hard reset.

Specified by:

hardReset in interface Resettable

Returns:

true if successful.

start

public void start()

Description copied from interface: Service

Start the service.

Specified by:

start in interface Service

stop

public void stop()
          throws FailedToStopException

Description copied from interface: Stoppable

Stop executing. This method should not return until the Stoppable has actually stopped.

Specified by:

stop in interface Stoppable

Throws:

FailedToStopException

filter

protected T filter(T from)

Specified by:

filter in class AbstractFilter<T,T>

getBeans

public BusCollect.ListContainer<T> getBeans()

Property: beans

Description: The same as list. Prefer list, will be deprecated in future versions.

Required: Read only.

Returns:

A list container.

getList

public BusCollect.ListContainer<T> getList()

getMap

public BusCollect.MapContainer<java.lang.Object,java.lang.Object> getMap()

getCount

public int getCount()

getKeyMapper

public java.util.function.Function<? super T,java.lang.Object> getKeyMapper()

setKeyMapper

public void setKeyMapper(java.util.function.Function<? super T,java.lang.Object> keyMapper)

getValueMapper

public java.util.function.Function<? super T,java.lang.Object> getValueMapper()

setValueMapper

public void setValueMapper(java.util.function.Function<? super T,java.lang.Object> valueMapper)

getOutput

public java.io.OutputStream getOutput()

setOutput

public void setOutput(java.io.OutputStream output)