Package net.sf.eBus.config

Class EConfigure.DispatcherBuilder

java.lang.Object

net.sf.eBus.config.EConfigure.DispatcherBuilder

Enclosing class:

EConfigure

public static final class EConfigure.DispatcherBuilder
extends Object

Constructs an EConfigure.Dispatcher configuration instance based on the parameters set via the builder's API. The minimally allowed configuration is the Dispatcher name and Dispatcher type if that type is either EConfigure.DispatcherType.SWING or EConfigure.DispatcherType.JAVAFX. For a EConfigure.DispatcherType.EBUS Dispatcher type, then the thread type must be provided. If this Dispatcher is not marked as the default, then the classes assigned to this Dispatcher must be provided.

The remaining properties are set to the following defaults:

• spin limit: EConfigure.DEFAULT_SPIN_LIMIT.
• park time: EConfigure.DEFAULT_PARK_TIME.
• priority: Thread.NORM_PRIORITY.
• quantum: EConfigure.DEFAULT_QUANTUM.
• thread count: EConfigure.DEFAULT_NUMBER_THREADS.
• default Dispatcher: false.
• thread affinity: null.

Note: there is no example of how to build a Dispatcher in application code because eBus dispatchers must be created on system start. Once the application main method is reached, it is too late to create a dispatcher.

Author:

Charles W. Rapp

Method Summary

Modifier and Type	Method	Description
EConfigure.Dispatcher	build()	Returns the eBus Dispatcher configuration built from the previously set parameters.
EConfigure.DispatcherBuilder	classes(Class<?>[] classes)	Lists the classes assigned to the dispatcher.
EConfigure.DispatcherBuilder	configuration(EConfigure.Dispatcher config)	Copies in the settings from config to this builder.
EConfigure.DispatcherBuilder	dispatcherType(EConfigure.DispatcherType type)	Sets the dispatcher type.
EConfigure.DispatcherBuilder	isDefault(boolean flag)	If flag is true, then marks the dispatcher as the default dispatcher.
EConfigure.DispatcherBuilder	name(String name)	Sets the dispatcher name.
EConfigure.DispatcherBuilder	numberThreads(int numThreads)	Sets the number of threads used by the run queue.
EConfigure.DispatcherBuilder	parkTime(Duration time)	Sets the ThreadType.SPINPARK park time limit.
EConfigure.DispatcherBuilder	priority(int priority)	Sets the run queue thread priority.
EConfigure.DispatcherBuilder	quantum(Duration quantum)	Sets the run quantum assigned to each eBus client.
EConfigure.DispatcherBuilder	spinLimit(long limit)	Sets the ThreadType.SPINPARK or ThreadType.SPINYIELD spin limit.
EConfigure.DispatcherBuilder	threadAffinity(List<ThreadAffinityConfigure> affinities)	Sets optional thread affinity to the given configuration list .
EConfigure.DispatcherBuilder	threadAffinity(ThreadAffinityConfigure[] affinities)	Sets optional thread affinity to the given configuration list .
EConfigure.DispatcherBuilder	threadType(ThreadType type)	Sets the run queue thread type.

Methods inherited from class java.lang.Object

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

Method Detail

configuration

public EConfigure.DispatcherBuilder configuration(EConfigure.Dispatcher config)

Copies in the settings from config to this builder. This method is provided for making changes to an existing configuration since EConfigure.Dispatcher is immutable.

if config is null, then nothing is done and the builder remains unchanged.

Parameters:

config - copy settings from this configuration.

Returns:

this dispatcher builder.

name

public EConfigure.DispatcherBuilder name(String name)

Sets the dispatcher name.

Parameters:

name - dispatcher name.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if name is null or empty.

dispatcherType

public EConfigure.DispatcherBuilder dispatcherType(EConfigure.DispatcherType type)

Sets the dispatcher type.

Parameters:

type - dispatcher type.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if type is null or an unknown dispatcher type.

threadType

public EConfigure.DispatcherBuilder threadType(ThreadType type)

Sets the run queue thread type. This setting is ignored if the Dispatcher type is EConfigure.DispatcherType.SWING or EConfigure.DispatcherType.JAVAFX.

Parameters:

type - thread type.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if type is null or an unknown thread type.

spinLimit

public EConfigure.DispatcherBuilder spinLimit(long limit)

Sets the ThreadType.SPINPARK or ThreadType.SPINYIELD spin limit. This setting is ignored for any other run queue thread type.

Parameters:

limit - spin limit.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if limit < zero.

parkTime

public EConfigure.DispatcherBuilder parkTime(Duration time)

Sets the ThreadType.SPINPARK park time limit. This setting is ignored for any other run queue thread type.

Parameters:

time - park time limit.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if time is null or < zero.

priority

public EConfigure.DispatcherBuilder priority(int priority)

Sets the run queue thread priority. Must be ≥ Thread.MIN_PRIORITY and ≤ Thread.MAX_PRIORITY. This setting is ignored if the Dispatcher type is EConfigure.DispatcherType.SWING or EConfigure.DispatcherType.JAVAFX.

Parameters:

priority - assigned thread priority for run queue threads.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if priority < zero or > Thread.MAX_PRIORITY.

quantum

public EConfigure.DispatcherBuilder quantum(Duration quantum)

Sets the run quantum assigned to each eBus client.

Parameters:

quantum - run quantum.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if quantum is null or < zero.

numberThreads

public EConfigure.DispatcherBuilder numberThreads(int numThreads)

Sets the number of threads used by the run queue. This setting is ignored if the Dispatcher type is EConfigure.DispatcherType.SWING or EConfigure.DispatcherType.JAVAFX.

Parameters:

numThreads - number of run queue threads.

Returns:

this dispatcher builder.

Throws:

com.typesafe.config.ConfigException - if numThreads < zero.

isDefault

public EConfigure.DispatcherBuilder isDefault(boolean flag)

If flag is true, then marks the dispatcher as the default dispatcher.

Parameters:

flag - true marks the dispatcher as the default.

Returns:

this dispatcher builder.

classes

public EConfigure.DispatcherBuilder classes(Class<?>[] classes)

Lists the classes assigned to the dispatcher. If the default dispatcher, this list is ignored and classes may be null or empty. If the dispatcher is not default, then classes must be defined as a non-null, non-empty array.

This parameter is checked when the dispatcher is built since the validation depends on whether the dispatcher is default or not.

Parameters:

classes - eBus client classes assigned to the Dispatcher.

Returns:

this dispatcher builder.

threadAffinity

public EConfigure.DispatcherBuilder threadAffinity(List<ThreadAffinityConfigure> affinities)

Sets optional thread affinity to the given configuration list . Thread affinity should be considered when using spinning thread type.

Parameters:

affinities - thread affinity configuration. May be null or empty.

Returns:

this dispatcher builder.

threadAffinity

public EConfigure.DispatcherBuilder threadAffinity(ThreadAffinityConfigure[] affinities)

Sets optional thread affinity to the given configuration list . Thread affinity should be considered when using spinning thread type.

Parameters:

affinities - thread affinity configuration. May be null or empty.

Returns:

this dispatcher builder.

build

public EConfigure.Dispatcher build()

Returns the eBus Dispatcher configuration built from the previously set parameters.

Returns:

an eBus Dispatcher configuration.

Throws:

com.typesafe.config.ConfigException - if either the Dispatcher name, Dispatcher type, or run queue thread type are not set, or if the Dispatcher is not marked as default and no classes were provided.