org.tools4j.nobark.queue

Interface ConflationQueueBuilder<K,V>

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

All Known Implementing Classes:

ConflationQueueBuilderImpl, ConflationQueueBuilderImpl.DeclaredKeysBuilder, ConflationQueueBuilderImpl.DefaultBuilder, ConflationQueueBuilderImpl.EnumKeyBuilder

public interface ConflationQueueBuilder<K,V>

Builder for the different types of conflation queues serving as alternative to the queue constructors; a builder is returned by the static methods of this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConflationQueueBuilder.ExchangeConflationQueueBuilder<K,V> Builder for ExchangeConflationQueue subtypes.

Method Summary

Modifier and Type	Method and Description
ConflationQueue<K,V>	build(java.util.function.Supplier<? extends java.util.Queue<java.lang.Object>> queueFactory) Builds and returns a new conflation queue instance using the given queue factory for the backing queue.
static <K,V> ConflationQueueBuilder<K,V>	builder() Creates an initial builder; use this method only when conflation keys are not known in advance
static <K,V> ConflationQueueBuilder<K,V>	builder(java.lang.Class<K> keyType, java.lang.Class<V> valueType) Creates an initial builder; use this method only when conflation keys are not known in advance.
static <K,V> ConflationQueueBuilder<K,V>	declareAllConflationKeys(K... allConflationKeys) Creates an initial builder given all conflation keys (exhaustive!).
static <K,V> ConflationQueueBuilder<K,V>	declareAllConflationKeys(java.util.List<K> allConflationKeys) Creates an initial builder given all conflation keys (exhaustive!).
static <K,V> ConflationQueueBuilder<K,V>	declareAllConflationKeys(java.util.List<K> allConflationKeys, java.lang.Class<V> valueType) Creates an initial builder given all conflation keys (exhaustive!).
static <K extends java.lang.Enum<K>,V> ConflationQueueBuilder<K,V>	forEnumConflationKey(java.lang.Class<K> keyType) Creates an initial builder given the enum conflation key class.
static <K extends java.lang.Enum<K>,V> ConflationQueueBuilder<K,V>	forEnumConflationKey(java.lang.Class<K> keyType, java.lang.Class<V> valueType) Creates an initial builder given the enum conflation key class.
ConflationQueueBuilder<K,V>	withAppenderListener(java.util.function.Supplier<? extends AppenderListener<? super K,? super V>> listenerSupplier) Register a listener as created by the specified supplier when creating queue appenders.
ConflationQueueBuilder.ExchangeConflationQueueBuilder<K,V>	withExchangeValueSupport() Switch builder mode to create a conflation queue that allows exchanging of elements between the consumer and the producer, that is, the builder will now create a ExchangeConflationQueue.
ConflationQueueBuilder.ExchangeConflationQueueBuilder<K,V>	withMerging(Merger<? super K,V> merger) Switch builder mode to create a conflation queue that supports merging of old and new values when conflation occurs, that is, the builder will now create a MergeConflationQueue.
ConflationQueueBuilder<K,V>	withPollerListener(java.util.function.Supplier<? extends PollerListener<? super K,? super V>> listenerSupplier) Register a listener as created by the specified supplier when creating queue pollers.

Method Detail

builder

static <K,V> ConflationQueueBuilder<K,V> builder()

Creates an initial builder; use this method only when conflation keys are not known in advance

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Returns:

a new builder

builder

static <K,V> ConflationQueueBuilder<K,V> builder(java.lang.Class<K> keyType,
                                                 java.lang.Class<V> valueType)

Creates an initial builder; use this method only when conflation keys are not known in advance.

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Parameters:

keyType - the type of the conflation key, used only to infer the generic type of the builder

valueType - the type of elements in the queue, used only to infer the generic type of the builder

Returns:

a new builder

declareAllConflationKeys

@SafeVarargs
static <K,V> ConflationQueueBuilder<K,V> declareAllConflationKeys(K... allConflationKeys)

Creates an initial builder given all conflation keys (exhaustive!).

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Parameters:

allConflationKeys - an exhaustive list of all conflation keys that will ever be used for the queue

Returns:

a new builder

declareAllConflationKeys

static <K,V> ConflationQueueBuilder<K,V> declareAllConflationKeys(java.util.List<K> allConflationKeys)

Creates an initial builder given all conflation keys (exhaustive!).

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Parameters:

allConflationKeys - an exhaustive list of all conflation keys that will ever be used for the queue

Returns:

a new builder

declareAllConflationKeys

static <K,V> ConflationQueueBuilder<K,V> declareAllConflationKeys(java.util.List<K> allConflationKeys,
                                                                  java.lang.Class<V> valueType)

Creates an initial builder given all conflation keys (exhaustive!).

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Parameters:

allConflationKeys - an exhaustive list of all conflation keys that will ever be used for the queue

valueType - the type of elements in the queue, used only to infer the generic type of the builder

Returns:

a new builder

forEnumConflationKey

static <K extends java.lang.Enum<K>,V> ConflationQueueBuilder<K,V> forEnumConflationKey(java.lang.Class<K> keyType)

Creates an initial builder given the enum conflation key class.

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Parameters:

keyType - the type of the conflation key

Returns:

a new builder

forEnumConflationKey

static <K extends java.lang.Enum<K>,V> ConflationQueueBuilder<K,V> forEnumConflationKey(java.lang.Class<K> keyType,
                                                                                        java.lang.Class<V> valueType)

Creates an initial builder given the enum conflation key class.

Type Parameters:

K - the type of the conflation key

V - the type of elements in the queue

Parameters:

keyType - the type of the conflation key

valueType - the type of elements in the queue, used only to infer the generic type of the builder

Returns:

a new builder

withAppenderListener

ConflationQueueBuilder<K,V> withAppenderListener(java.util.function.Supplier<? extends AppenderListener<? super K,? super V>> listenerSupplier)

Register a listener as created by the specified supplier when creating queue appenders. The created listeners must be thread safe for multi-producer queues, e.g. consider using AppenderListener.threadLocalSupplier(Supplier).

Parameters:

listenerSupplier - a listener supplier acting as listener factory

Returns:

the builder

withPollerListener

ConflationQueueBuilder<K,V> withPollerListener(java.util.function.Supplier<? extends PollerListener<? super K,? super V>> listenerSupplier)

Register a listener as created by the specified supplier when creating queue pollers. The created listeners must be thread safe for multi-consumer queues, e.g. consider using PollerListener.threadLocalSupplier(Supplier).

Parameters:

listenerSupplier - a listener supplier acting as listener factory

Returns:

the builder

withExchangeValueSupport

ConflationQueueBuilder.ExchangeConflationQueueBuilder<K,V> withExchangeValueSupport()

Switch builder mode to create a conflation queue that allows exchanging of elements between the consumer and the producer, that is, the builder will now create a ExchangeConflationQueue.

Returns:

a builder for an ExchangeConflationQueue, more specifically an EvictConflationQueue

See Also:

ExchangeConflationQueue, EvictConflationQueue, withMerging(Merger)

withMerging

ConflationQueueBuilder.ExchangeConflationQueueBuilder<K,V> withMerging(Merger<? super K,V> merger)

Switch builder mode to create a conflation queue that supports merging of old and new values when conflation occurs, that is, the builder will now create a MergeConflationQueue.

Parameters:

merger - merge strategy to use when conflation occurs

Returns:

a builder for an ExchangeConflationQueue, more specifically a MergeConflationQueue

See Also:

ExchangeConflationQueue, MergeConflationQueue, withExchangeValueSupport()

build

ConflationQueue<K,V> build(java.util.function.Supplier<? extends java.util.Queue<java.lang.Object>> queueFactory)

Builds and returns a new conflation queue instance using the given queue factory for the backing queue. The backing queue determines whether single or multiple producers and consumers are supported.

Parameters:

queueFactory - the factory to create the backing queue

Returns:

a new conflation queue instance