A B C D E F H I J K L M N O P R S T V W

A

alwaysProvide(Step) - Static method in interface org.tools4j.nobark.loop.StepProvider

Returns a provider for the given step used for both normal and shutdown phase.

appender() - Method in class org.tools4j.nobark.queue.AtomicConflationQueue

appender() - Method in interface org.tools4j.nobark.queue.ConflationQueue

Returns the appender object used by the producer to enqueue values.

appender() - Method in class org.tools4j.nobark.queue.EvictConflationQueue

appender() - Method in interface org.tools4j.nobark.queue.ExchangeConflationQueue

appender() - Method in class org.tools4j.nobark.queue.MergeConflationQueue

AppenderListener<K,V> - Interface in org.tools4j.nobark.queue

A listener for an appender of a ConflationQueue for instance useful to record performance metrics related to enqueue operations.

AppenderListener.Conflation - Enum in org.tools4j.nobark.queue

The type of conflation that occurred when an element was enqueued.

AtomicConflationQueue<K,V> - Class in org.tools4j.nobark.queue

A conflation queue implementation that atomically evicts old values from the queue if a new one is enqueued with the same conflation key.

AtomicConflationQueue(Supplier<? extends Queue<Object>>) - Constructor for class org.tools4j.nobark.queue.AtomicConflationQueue

Constructor with queue factory.

AtomicConflationQueue(Supplier<? extends Queue<Object>>, AppenderListener<? super K, ? super V>, PollerListener<? super K, ? super V>) - Constructor for class org.tools4j.nobark.queue.AtomicConflationQueue

Constructor with queue factory.

AtomicConflationQueue(Supplier<? extends Queue<Object>>, Supplier<? extends Map<Object, Object>>, AppenderListener<? super K, ? super V>, PollerListener<? super K, ? super V>) - Constructor for class org.tools4j.nobark.queue.AtomicConflationQueue

Constructor with queue factory and entry map factory.

AtomicConflationQueue(Supplier<? extends Queue<Object>>, List<? extends K>) - Constructor for class org.tools4j.nobark.queue.AtomicConflationQueue

Constructor with queue factory and the exhaustive list of conflation keys.

AtomicConflationQueue(Supplier<? extends Queue<Object>>, List<? extends K>, AppenderListener<? super K, ? super V>, PollerListener<? super K, ? super V>) - Constructor for class org.tools4j.nobark.queue.AtomicConflationQueue

Constructor with queue factory and the exhaustive list of conflation keys.

atomicQueue(Supplier<? extends Queue<Object>>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilderImpl.CqFactory

Factory method for AtomicConflationQueue

awaitTermination(long, TimeUnit) - Method in interface org.tools4j.nobark.run.Shutdownable

Blocks until this service has terminated, or the timeout occurs, whichever happens first.

awaitTermination(long, TimeUnit) - Method in class org.tools4j.nobark.run.ShutdownableThread

B

build(Supplier<? extends Queue<Object>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

Builds and returns a new conflation queue instance using the given queue factory for the backing queue.

build(Supplier<? extends Queue<Object>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder.ExchangeConflationQueueBuilder

Builds and returns a new exchange conflation queue instance using the given queue factory for the backing queue.

build(Supplier<? extends Queue<Object>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl

build(Supplier<? extends Queue<Object>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.EvictConflationQueueBuilder

build(Supplier<? extends Queue<Object>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.MergeConflationQueueBuilder

builder() - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

builder(Class<K>, Class<V>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

builder(Supplier<? extends Map<Object, Object>>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

builder(Class<K>, Class<V>, Supplier<? extends Map<Object, Object>>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

C

close() - Method in interface org.tools4j.nobark.run.Stoppable

Stops the service by calling the Stoppable.stop() method.

ComposableStep - Interface in org.tools4j.nobark.loop

Extension of Step with enhanced functionality facilitating the composition of step chains.

composite(Step...) - Static method in interface org.tools4j.nobark.loop.ComposableStep

Returns a step that runs all given component steps; the Step.perform() method of the resulting composite step returns true if any of the component steps returns true.

ConflationQueue<K,V> - Interface in org.tools4j.nobark.queue

A conflation queue is a queue with a safety mechanism to prevent overflow.

ConflationQueue.Appender<K,V> - Interface in org.tools4j.nobark.queue

Appender used by the producer to enqueue values.

ConflationQueue.Poller<K,V> - Interface in org.tools4j.nobark.queue

Poller object used by the consumer to poll values.

ConflationQueueBuilder<K,V> - Interface in org.tools4j.nobark.queue

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.

ConflationQueueBuilder.ExchangeConflationQueueBuilder<K,V> - Interface in org.tools4j.nobark.queue

Builder for ExchangeConflationQueue subtypes.

ConflationQueueBuilderImpl<K,V> - Class in org.tools4j.nobark.queue

Package local builder implementation as returned by the static methods of ConflationQueueBuilder.

ConflationQueueBuilderImpl.CqFactory<K,V> - Interface in org.tools4j.nobark.queue

Builder-internal factory for different types of conflation queues.

ConflationQueueBuilderImpl.DeclaredKeysBuilder<K,V> - Class in org.tools4j.nobark.queue

Builder for the case that conflation keys are declared.

ConflationQueueBuilderImpl.DefaultBuilder<K,V> - Class in org.tools4j.nobark.queue

Default builder for the case that no conflation keys are declared.

ConflationQueueBuilderImpl.EntryMapFactoryBuilder<K,V> - Class in org.tools4j.nobark.queue

Builder for the case that an entry map factory has been provided.

ConflationQueueBuilderImpl.EnumKeyBuilder<K extends java.lang.Enum<K>,V> - Class in org.tools4j.nobark.queue

Builder for enum conflation key types.

ConflationQueueBuilderImpl.EvictConflationQueueBuilder - Class in org.tools4j.nobark.queue

Builder for EvictConflationQueue.

ConflationQueueBuilderImpl.MergeConflationQueueBuilder - Class in org.tools4j.nobark.queue

Builder for MergeConflationQueue.

create(Step) - Static method in interface org.tools4j.nobark.loop.ComposableStep

Returns a composable step given a "normal" step.

create(RunnableFactory.RunningCondition) - Method in interface org.tools4j.nobark.run.RunnableFactory

Creates a runnable that stops when the supplied runningCondition returns false.

createMap(Supplier<? extends Map<Object, Object>>) - Static method in class org.tools4j.nobark.queue.Factories

Encapsulates the unsafe cast necessary when creating a map with a factory that is unaware of the key/value types of the map.

createQueue(Supplier<? extends Queue<Object>>) - Static method in class org.tools4j.nobark.queue.Factories

Encapsulates the unsafe cast necessary when creating a queue with a factory that is unaware of the value type of the queue.

D

declareAllConflationKeys(K...) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

declareAllConflationKeys(List<K>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

declareAllConflationKeys(List<K>, Class<V>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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

DeclaredKeysBuilder(List<? extends K>) - Constructor for class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.DeclaredKeysBuilder

DefaultBuilder() - Constructor for class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.DefaultBuilder

E

eagerlyInitialiseEntryEnumMap(Class<K>, Supplier<V>) - Static method in class org.tools4j.nobark.queue.Entry

Eagerly initializes an enum map using all enum constants as keys and creating values with the given value factory.

eagerlyInitialiseEntryMap(List<? extends K>, Supplier<V>) - Static method in class org.tools4j.nobark.queue.Entry

Eagerly initializes a hash map using all provided keys and creating values with the given value factory.

enqueue(K, V) - Method in interface org.tools4j.nobark.queue.ConflationQueue.Appender

Enqueue the specified value using the given conflation key.

enqueued(ConflationQueue<? extends K, ? extends V>, K, V, V, AppenderListener.Conflation) - Method in interface org.tools4j.nobark.queue.AppenderListener

Called whenever a value is enqueued.

Entry<K,V> - Class in org.tools4j.nobark.queue

Package local immutable wrapper object used by the queue implementations; holds conflation key and a value.

Entry(K, V) - Constructor for class org.tools4j.nobark.queue.Entry

Constructor with conflation key and value

EntryMapFactoryBuilder(Supplier<? extends Map<Object, Object>>) - Constructor for class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.EntryMapFactoryBuilder

EnumKeyBuilder(Class<K>) - Constructor for class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.EnumKeyBuilder

EvictConflationQueue<K,V> - Class in org.tools4j.nobark.queue

A conflation queue implementation that evicts old values from the queue if a new one is enqueued with the same conflation key.

EvictConflationQueue(Supplier<? extends Queue<Object>>) - Constructor for class org.tools4j.nobark.queue.EvictConflationQueue

Constructor with queue factory.

EvictConflationQueue(Supplier<? extends Queue<Object>>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Constructor for class org.tools4j.nobark.queue.EvictConflationQueue

Constructor with queue factory.

EvictConflationQueue(Supplier<? extends Queue<Object>>, Supplier<? extends Map<Object, Object>>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Constructor for class org.tools4j.nobark.queue.EvictConflationQueue

Constructor with queue factory and entry map factory.

EvictConflationQueue(Supplier<? extends Queue<Object>>, List<? extends K>) - Constructor for class org.tools4j.nobark.queue.EvictConflationQueue

Constructor with queue factory and the exhaustive list of conflation keys.

EvictConflationQueue(Supplier<? extends Queue<Object>>, List<? extends K>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Constructor for class org.tools4j.nobark.queue.EvictConflationQueue

Constructor with queue factory and the exhaustive list of conflation keys.

EvictConflationQueueBuilder() - Constructor for class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.EvictConflationQueueBuilder

evictQueue(Supplier<? extends Queue<Object>>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilderImpl.CqFactory

Factory method for EvictConflationQueue.

ExceptionHandler - Interface in org.tools4j.nobark.loop

Handler for unexpected exceptions thrown by a Step in a Loop.

ExchangeConflationQueue<K,V> - Interface in org.tools4j.nobark.queue

A conflation queue variant that allows exchanging of elements between the consumer and the producer.

ExchangeConflationQueue.ExchangePoller<K,V> - Interface in org.tools4j.nobark.queue

Poller object used by the consumer to poll values; exchange poller adds functionality for exchanging values with the producer during poll operations.

F

Factories - Class in org.tools4j.nobark.queue

Helper class dealing with unsafe casts necessary for factories of objects whose generic types are not known to the factory provider.

forEnumConflationKey(Supplier<? extends Queue<Object>>, Class<K>) - Static method in class org.tools4j.nobark.queue.AtomicConflationQueue

Static constructor method for a conflation queue with queue factory and the conflation key enum class.

forEnumConflationKey(Supplier<? extends Queue<Object>>, Class<K>, AppenderListener<? super K, ? super V>, PollerListener<? super K, ? super V>) - Static method in class org.tools4j.nobark.queue.AtomicConflationQueue

Static constructor method for a conflation queue with queue factory and the conflation key enum class.

forEnumConflationKey(Class<K>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

Creates an initial builder given the enum conflation key class.

forEnumConflationKey(Class<K>, Class<V>) - Static method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

Creates an initial builder given the enum conflation key class.

forEnumConflationKey(Supplier<? extends Queue<Object>>, Class<K>) - Static method in class org.tools4j.nobark.queue.EvictConflationQueue

Static constructor method for a conflation queue with queue factory and the conflation key enum class.

forEnumConflationKey(Supplier<? extends Queue<Object>>, Class<K>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Static method in class org.tools4j.nobark.queue.EvictConflationQueue

Static constructor method for a conflation queue with queue factory and the conflation key enum class.

forEnumConflationKey(Supplier<? extends Queue<Object>>, Merger<? super K, V>, Class<K>) - Static method in class org.tools4j.nobark.queue.MergeConflationQueue

Static constructor method for a conflation queue with queue factory, merger and the conflation key enum class.

forEnumConflationKey(Supplier<? extends Queue<Object>>, Merger<? super K, V>, Class<K>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Static method in class org.tools4j.nobark.queue.MergeConflationQueue

Static constructor method for a conflation queue with queue factory, merger and the conflation key enum class.

H

handleException(Loop, Step, Throwable) - Method in interface org.tools4j.nobark.loop.ExceptionHandler

Handles an unexpected exception that was thrown by the given step that is part of the given loop.

I

idle() - Method in interface org.tools4j.nobark.loop.IdleStrategy

Invoked if no work was done

idle(boolean) - Method in interface org.tools4j.nobark.loop.IdleStrategy

Invoked with boolean flag indicating whether work was done or not.

IdleStrategy - Interface in org.tools4j.nobark.loop

Handler to define strategy in idle loops when no work is performed.

isRunning() - Method in interface org.tools4j.nobark.run.ThreadState

Returns true if the underlying thread has been started but has not yet terminated.

isShutdown() - Method in interface org.tools4j.nobark.run.Shutdownable

Returns true if this service has been shut down.

isShutdown() - Method in class org.tools4j.nobark.run.ShutdownableThread

isTerminated() - Method in interface org.tools4j.nobark.run.Shutdownable

Returns true if this service has terminated.

isTerminated() - Method in class org.tools4j.nobark.run.ShutdownableThread

isTerminated() - Method in interface org.tools4j.nobark.run.ThreadState

Returns true if the underlying thread has terminated.

J

join() - Method in interface org.tools4j.nobark.run.Joinable

Waits for this Joinable to die.

join(long) - Method in interface org.tools4j.nobark.run.Joinable

Waits at most millis milliseconds for this Joinable to die.

join(long) - Method in class org.tools4j.nobark.run.ShutdownableThread

Delegates to ShutdownableThread.awaitTermination(long, TimeUnit).

join(long) - Method in class org.tools4j.nobark.run.StoppableThread

Joinable - Interface in org.tools4j.nobark.run

Joinable is a running service such as a thread that can be joined to await its termination.

K

keepRunning() - Method in interface org.tools4j.nobark.run.RunnableFactory.RunningCondition

Returns true if the runnable should continue its work and false if it should abort and return from te run() method.

key - Variable in class org.tools4j.nobark.queue.Entry

L

Loop - Class in org.tools4j.nobark.loop

A loop performing a series of steps in an iterative manner as long as the LoopCondition is true.

Loop(LoopCondition, IdleStrategy, ExceptionHandler, Step...) - Constructor for class org.tools4j.nobark.loop.Loop

Constructor with loop condition, idle strategy, step exception handler and the steps to perform.

loopAgain(boolean) - Method in interface org.tools4j.nobark.loop.LoopCondition

Returns true if the loop should continue, and false otherwise.

LoopCondition - Interface in org.tools4j.nobark.loop

While condition for a Loop.

M

mainLoop(LoopCondition, IdleStrategy, ExceptionHandler, StepProvider...) - Static method in class org.tools4j.nobark.loop.Loop

Static factory method creating a loop with normal steps using the given providers to construct the loop steps.

merge(K, V, V) - Method in interface org.tools4j.nobark.queue.Merger

Method called to merge two values; the merged value is returned.

MergeConflationQueue<K,V> - Class in org.tools4j.nobark.queue

A conflation queue implementation that merges old and new value if a value is enqueued and another one already exists in the queue with the same conflation key.

MergeConflationQueue(Supplier<? extends Queue<Object>>, Merger<? super K, V>) - Constructor for class org.tools4j.nobark.queue.MergeConflationQueue

Constructor with queue factory and merger.

MergeConflationQueue(Supplier<? extends Queue<Object>>, Merger<? super K, V>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Constructor for class org.tools4j.nobark.queue.MergeConflationQueue

Constructor with queue factory and merger.

MergeConflationQueue(Supplier<? extends Queue<Object>>, Supplier<? extends Map<Object, Object>>, Merger<? super K, V>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Constructor for class org.tools4j.nobark.queue.MergeConflationQueue

Constructor with queue factory, entry map factory and merger.

MergeConflationQueue(Supplier<? extends Queue<Object>>, Merger<? super K, V>, List<? extends K>) - Constructor for class org.tools4j.nobark.queue.MergeConflationQueue

Constructor with queue factory, merger and the exhaustive list of conflation keys.

MergeConflationQueue(Supplier<? extends Queue<Object>>, Merger<? super K, V>, List<? extends K>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Constructor for class org.tools4j.nobark.queue.MergeConflationQueue

Constructor with queue factory, merger and the exhaustive list of conflation keys.

MergeConflationQueueBuilder(Merger<? super K, V>) - Constructor for class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.MergeConflationQueueBuilder

mergeQueue(Supplier<? extends Queue<Object>>, Merger<? super K, V>, Supplier<? extends AppenderListener<? super K, ? super V>>, Supplier<? extends PollerListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilderImpl.CqFactory

Factory method for MergeConflationQueue.

Merger<K,V> - Interface in org.tools4j.nobark.queue

Merger strategy passed to some conflation queues upon construction to support merging of values when conflation occurs.

N

NO_OP - Static variable in interface org.tools4j.nobark.loop.ComposableStep

Step performing a no-OP; the implementation returns false indicating that no work was performed.

NO_OP - Static variable in interface org.tools4j.nobark.loop.IdleStrategy

Idle strategy that performs a no-OP, that is, an idle loop will essentially become a busy-spin loop.

NO_OP - Static variable in interface org.tools4j.nobark.loop.Step

Step performing a no-OP; the implementation returns false indicating that no work was performed.

NOOP - Static variable in interface org.tools4j.nobark.queue.AppenderListener

Constant for a no-op listener.

NOOP - Static variable in interface org.tools4j.nobark.queue.PollerListener

Constant for a no-op listener.

normalStep(StepProvider) - Static method in interface org.tools4j.nobark.loop.StepProvider

Returns a normal step using the given supplier.

nullSafe(ExchangeConflationQueue<K, V>, Function<? super K, ? extends V>) - Static method in interface org.tools4j.nobark.queue.ExchangeConflationQueue

Returns an ExchangeConflationQueue whose appender is guaranteed to never return null on enqueue.

nullSafe(ConflationQueue.Appender<K, V>, Function<? super K, ? extends V>) - Static method in interface org.tools4j.nobark.queue.ExchangeConflationQueue

Returns an Appender whose enqueue(..) method is guaranteed to never return null.

O

org.tools4j.nobark.loop - package org.tools4j.nobark.loop

Provides interfaces and classes with simple building blocks for event loops based on executable steps similar to runnables; loops provide direct support for an IdleStrategy and an ExceptionHandler.

org.tools4j.nobark.queue - package org.tools4j.nobark.queue

Provides interfaces and different implementations of conflation queues -- efficient lock-free queues with a built-in safety mechanism to prevent overflow by the producer.

org.tools4j.nobark.run - package org.tools4j.nobark.run

Provides interfaces and classes to build thread-like running services that can be stopped, joined or shutdown orderly and abruptly in a controllable way.

P

perform() - Method in interface org.tools4j.nobark.loop.Step

Executes this step and returns true if substantial work was performed.

performQuietly(Loop, Step) - Method in interface org.tools4j.nobark.loop.ExceptionHandler

Performs the step's method handling possible exceptions by invoking this handler's ExceptionHandler.handleException(Loop, Step, Throwable) method.

poll(BiConsumer<? super K, ? super V>) - Method in interface org.tools4j.nobark.queue.ConflationQueue.Poller

Polls the queue passing a consumer which is invoked with conflation key and polled value if the queue was non-empty.

poll() - Method in interface org.tools4j.nobark.queue.ConflationQueue.Poller

Polls the queue and returns the value if any value was present in the queue, or null if the queue was empty.

poll(BiConsumer<? super K, ? super V>, V) - Method in interface org.tools4j.nobark.queue.ExchangeConflationQueue.ExchangePoller

Polls the queue passing an unused value in exchange to the queue.

poll(V) - Method in interface org.tools4j.nobark.queue.ExchangeConflationQueue.ExchangePoller

Polls the queue passing an unused value in exchange to the queue.

poll(BiConsumer<? super K, ? super V>) - Method in interface org.tools4j.nobark.queue.ExchangeConflationQueue.ExchangePoller

polled(ConflationQueue<? extends K, ? extends V>, K, V) - Method in interface org.tools4j.nobark.queue.PollerListener

Called whenever a value is polled via any of the poll methods.

polledButFoundEmpty(ConflationQueue<? extends K, ? extends V>) - Method in interface org.tools4j.nobark.queue.PollerListener

Called whenever a poll attempt was made but the queue was found empty.

poller() - Method in class org.tools4j.nobark.queue.AtomicConflationQueue

poller() - Method in interface org.tools4j.nobark.queue.ConflationQueue

Returns the poller object used by the consumer to poll values.

poller() - Method in class org.tools4j.nobark.queue.EvictConflationQueue

poller() - Method in interface org.tools4j.nobark.queue.ExchangeConflationQueue

poller() - Method in class org.tools4j.nobark.queue.MergeConflationQueue

PollerListener<K,V> - Interface in org.tools4j.nobark.queue

A listener for an poller of a ConflationQueue for instance useful to record performance metrics related to poll operations.

provide(boolean) - Method in interface org.tools4j.nobark.loop.StepProvider

Returns a step for normal or shutdown use.

R

reset() - Method in interface org.tools4j.nobark.loop.IdleStrategy

Invoked if some work was performed and an idle strategy should reset to prepare for the next idle phase

run() - Method in class org.tools4j.nobark.loop.Loop

RunnableFactory - Interface in org.tools4j.nobark.run

A factory for a Runnable that can be stopped by complying with a RunningCondition that is passed to the factory method upon construction of the runnable.

RunnableFactory.RunningCondition - Interface in org.tools4j.nobark.run

Condition for a runnable created by RunnableFactory.create(RunningCondition) telling the runnable when to stop.

S

shutdown() - Method in interface org.tools4j.nobark.run.Shutdownable

Initiates an orderly shutdown in which the service will be continue to perform its duties as long as there is work to be done.

shutdown() - Method in class org.tools4j.nobark.run.ShutdownableThread

Shutdownable - Interface in org.tools4j.nobark.run

Shutdownable is a running service such as a thread that can be shutdown orderly or abruptly in a way similar to ExecutorService.

ShutdownableThread - Class in org.tools4j.nobark.run

A thread that performs a main runnable in a new thread and another shutdown runnable the graceful ShutdownableThread.shutdown() phase of the thread.

ShutdownableThread(RunnableFactory, RunnableFactory, ThreadFactory) - Constructor for class org.tools4j.nobark.run.ShutdownableThread

Constructor for shutdownable thread; it is recommended to use the static start(..) methods instead.

shutdownLoop(LoopCondition, IdleStrategy, ExceptionHandler, StepProvider...) - Static method in class org.tools4j.nobark.loop.Loop

Static factory method creating a loop with shutdown steps using the given providers to construct the loop steps.

shutdownNow() - Method in interface org.tools4j.nobark.run.Shutdownable

Initiates an immediate shutdown in which the service will stop even if there is more work to be done.

shutdownNow() - Method in class org.tools4j.nobark.run.ShutdownableThread

shutdownStep(StepProvider) - Static method in interface org.tools4j.nobark.loop.StepProvider

Returns a shutdown step using the given supplier.

silenceDuringShutdown(Step) - Static method in interface org.tools4j.nobark.loop.StepProvider

Returns a provider for the given step used only for the normal phase; a no-OP is returned for the shutdown phase.

size() - Method in class org.tools4j.nobark.queue.AtomicConflationQueue

size() - Method in interface org.tools4j.nobark.queue.ConflationQueue

Returns the number of elements in this queue.

size() - Method in class org.tools4j.nobark.queue.EvictConflationQueue

size() - Method in class org.tools4j.nobark.queue.MergeConflationQueue

start(IdleStrategy, ExceptionHandler, ThreadFactory, Step...) - Static method in class org.tools4j.nobark.loop.Loop

Creates, starts and returns a new thread running a loop with the given steps.

start(IdleStrategy, ExceptionHandler, ThreadFactory, StepProvider...) - Static method in class org.tools4j.nobark.loop.Loop

Creates, starts and returns a new thread running first a main loop and then another shutdown loop during the graceful shutdown phase.

start(RunnableFactory, RunnableFactory, ThreadFactory) - Static method in class org.tools4j.nobark.run.ShutdownableThread

Creates, starts and returns a new shutdownable thread.

start(RunnableFactory, ThreadFactory) - Static method in class org.tools4j.nobark.run.StoppableThread

Creates, starts and returns a new shutdownable thread.

Step - Interface in org.tools4j.nobark.loop

Step is similar to Runnable but returns true if substantial work has been performed.

StepProvider - Interface in org.tools4j.nobark.loop

Provider for Step distinguishing between normal (main loop) steps and shutdown steps that are used during the termination phase of a ShutdownableThread as returned by Loop#start(..).

stop() - Method in class org.tools4j.nobark.run.ShutdownableThread

Calls ShutdownableThread.shutdown().

stop() - Method in interface org.tools4j.nobark.run.Stoppable

Stops the service.

stop() - Method in class org.tools4j.nobark.run.StoppableThread

Stoppable - Interface in org.tools4j.nobark.run

Stoppable is a running service such as a thread that can be stopped either by calling stop or via Stoppable.close() method of AutoCloseable.

StoppableThread - Class in org.tools4j.nobark.run

A thread that performs a runnable in a new thread.

StoppableThread(RunnableFactory, ThreadFactory) - Constructor for class org.tools4j.nobark.run.StoppableThread

Constructor for stoppable thread; it is recommended to use the static start(..) methods instead.

T

then(Step) - Method in interface org.tools4j.nobark.loop.ComposableStep

Returns a composable step that performs first this and then the next step.

thenIfNotPerformed(Step) - Method in interface org.tools4j.nobark.loop.ComposableStep

Returns a composable step that performs first this step and then the next step only if the first performed no work as indicated by result of the Step.perform() invocation.

thenIfPerformed(Step) - Method in interface org.tools4j.nobark.loop.ComposableStep

Returns a composable step that performs first this step and then the next step only if the first performed any work as indicated by result of the Step.perform() invocation.

ThreadLike - Interface in org.tools4j.nobark.run

A thread-like running service that can be stopped and joined.

threadLocal(Supplier<? extends AppenderListener<K, V>>) - Static method in interface org.tools4j.nobark.queue.AppenderListener

Creates an appender listener that delegates to thread-local listener instances created on demand by the given supplier.

threadLocal(Supplier<? extends PollerListener<K, V>>) - Static method in interface org.tools4j.nobark.queue.PollerListener

Creates a poller listener that delegates to thread-local listener instances created on demand by the given supplier.

threadLocalSupplier(Supplier<L>) - Static method in interface org.tools4j.nobark.queue.AppenderListener

Creates a thread local supplier that creates a new instance once for every caller thread.

threadLocalSupplier(Supplier<L>) - Static method in interface org.tools4j.nobark.queue.PollerListener

Creates a thread local supplier that creates a new instance once for every caller thread.

threadState() - Method in class org.tools4j.nobark.run.ShutdownableThread

threadState() - Method in class org.tools4j.nobark.run.StoppableThread

ThreadState - Interface in org.tools4j.nobark.run

The running state is a property of a running service such as a thread and is closely related to Thread.State.

threadState() - Method in interface org.tools4j.nobark.run.ThreadState

Returns the state of the underlying thread.

toString() - Method in class org.tools4j.nobark.run.ShutdownableThread

Returns the name of the thread that was created with the thread factory passed to the constructor.

toString() - Method in class org.tools4j.nobark.run.StoppableThread

V

value - Variable in class org.tools4j.nobark.queue.Entry

valueOf(String) - Static method in enum org.tools4j.nobark.queue.AppenderListener.Conflation

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.tools4j.nobark.queue.AppenderListener.Conflation

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAppenderListener(Supplier<? extends AppenderListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder.ExchangeConflationQueueBuilder

Register a listener as created by the specified supplier when creating queue appenders.

withAppenderListener(Supplier<? extends AppenderListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

Register a listener as created by the specified supplier when creating queue appenders.

withAppenderListener(Supplier<? extends AppenderListener<? super K, ? super V>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.EvictConflationQueueBuilder

withAppenderListener(Supplier<? extends AppenderListener<? super K, ? super V>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.MergeConflationQueueBuilder

withAppenderListener(Supplier<? extends AppenderListener<? super K, ? super V>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl

withExchangeValueSupport() - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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.

withExchangeValueSupport() - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl

withMerging(Merger<? super K, V>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

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.

withMerging(Merger<? super K, V>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl

withPollerListener(Supplier<? extends PollerListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder.ExchangeConflationQueueBuilder

Register a listener as created by the specified supplier when creating queue pollers.

withPollerListener(Supplier<? extends PollerListener<? super K, ? super V>>) - Method in interface org.tools4j.nobark.queue.ConflationQueueBuilder

Register a listener as created by the specified supplier when creating queue pollers.

withPollerListener(Supplier<? extends PollerListener<? super K, ? super V>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.EvictConflationQueueBuilder

withPollerListener(Supplier<? extends PollerListener<? super K, ? super V>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl.MergeConflationQueueBuilder

withPollerListener(Supplier<? extends PollerListener<? super K, ? super V>>) - Method in class org.tools4j.nobark.queue.ConflationQueueBuilderImpl

A B C D E F H I J K L M N O P R S T V W