EConfigure.DispatcherBuilder (eBus Configuration 5.0.0 API)

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.
Author:

Charles W. Rapp

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EConfigure.Dispatcher`	`build()` Returns the eBus Dispatcher configuration built from the previously set parameters.
`Class<?>[]`	`classes()` Returns the array of classes assigned to this Dispatcher.
`EConfigure.DispatcherBuilder`	`classes(Class<?>[] classes)` Lists the classes assigned to the dispatcher.
`EConfigure.DispatcherType`	`dispatcherType()` Returns the Dispatcher type.
`EConfigure.DispatcherBuilder`	`dispatcherType(EConfigure.DispatcherType type)` Sets the dispatcher type.
`boolean`	`isDefault()` Returns `true` if the Dispatcher is configured to be the default Dispatcher.
`EConfigure.DispatcherBuilder`	`isDefault(boolean flag)` If `flag` is `true`, then marks the dispatcher as the default dispatcher.
`String`	`name()` Returns the Dispatcher name.
`EConfigure.DispatcherBuilder`	`name(String name)` Sets the dispatcher name.
`int`	`numberThreads()` Returns the number of Dispatcher threads.
`EConfigure.DispatcherBuilder`	`numberThreads(int numThreads)` Sets the number of threads used by the run queue.
`long`	`parkTime()` Returns the nanosecond park time.
`EConfigure.DispatcherBuilder`	`parkTime(long time)` Sets the `ThreadType.SPINPARK` nanosecond park time.
`int`	`priority()` Returns the Dispatcher thread priority.
`EConfigure.DispatcherBuilder`	`priority(int priority)` Sets the run queue thread priority.
`long`	`quantum()` Returns the eBus client run quantum.
`EConfigure.DispatcherBuilder`	`quantum(long quantum)` Sets the run quantum assigned to each eBus client.
`long`	`spinLimit()` Returns the spin limit.
`EConfigure.DispatcherBuilder`	`spinLimit(long limit)` Sets the `ThreadType.SPINPARK` or `ThreadType.SPINYIELD` spin limit.
`ThreadType`	`threadType()` Returns the Dispatcher thread type.
`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
  - name
```
public String name()
```
    Returns the Dispatcher name. Returns null if the name is not set.
    
    Returns:
    
    Dispatcher name.
  - dispatcherType
```
public EConfigure.DispatcherType dispatcherType()
```
    Returns the Dispatcher type. Returns null if the Dispatcher type is not set.
    
    Returns:
    
    Dispatcher type.
  - threadType
```
public ThreadType threadType()
```
    Returns the Dispatcher thread type. Returns null if not yet set.
    
    Returns:
    
    Dispatcher thread type.
  - spinLimit
```
public long spinLimit()
```
    Returns the spin limit. This setting is valid only if the Dispatch type is EConfigure.DispatcherType.EBUS and the thread type is either ThreadType.SPINPARK or ThreadType.SPINYIELD.
    
    Returns:
    
    spin limit.
  - parkTime
```
public long parkTime()
```
    Returns the nanosecond park time. This setting is valid only if the Dispatch type is EConfigure.DispatcherType.EBUS and the thread type is ThreadType.SPINPARK.
    
    Returns:
    
    nanosecond park time.
  - priority
```
public int priority()
```
    Returns the Dispatcher thread priority.
    
    Returns:
    
    thread priority.
  - quantum
```
public long quantum()
```
    Returns the eBus client run quantum.
    
    Returns:
    
    run quantum.
  - numberThreads
```
public int numberThreads()
```
    Returns the number of Dispatcher threads.
    
    Returns:
    
    Dispatcher thread count.
  - isDefault
```
public boolean isDefault()
```
    Returns true if the Dispatcher is configured to be the default Dispatcher.
    
    Returns:
    
    true if default Dispatcher.
  - classes
```
public Class<?>[] classes()
```
    Returns the array of classes assigned to this Dispatcher. Does not return null. Returned array is a copy of this builder's class array.
    
    Returns:
    
    assigned class array.
  - name
```
public EConfigure.DispatcherBuilder name(String name)
```
    Sets the dispatcher name.
    
    Parameters:
    
    name - dispatcher name.
    
    Returns:
    
    this dispatcher builder.
    
    Throws:
    
    NullPointerException - if name is null.
    
    IllegalArgumentException - if name is empty.
  - dispatcherType
```
public EConfigure.DispatcherBuilder dispatcherType(EConfigure.DispatcherType type)
```
    Sets the dispatcher type.
    
    Parameters:
    
    type - dispatcher type.
    
    Returns:
    
    this dispatcher builder.
    
    Throws:
    
    NullPointerException - if type is null.
  - 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:
    
    NullPointerException - if type is null.
  - 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:
    
    IllegalArgumentException - if limit < zero.
  - parkTime
```
public EConfigure.DispatcherBuilder parkTime(long time)
```
    Sets the ThreadType.SPINPARK nanosecond park time. This setting is ignored for any other run queue thread type.
    
    Parameters:
    
    time - nanosecond park time.
    
    Returns:
    
    this dispatcher builder.
    
    Throws:
    
    IllegalArgumentException - if time < 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:
    
    IllegalArgumentException - if priority < zero or > Thread.MAX_PRIORITY.
  - quantum
```
public EConfigure.DispatcherBuilder quantum(long quantum)
```
    Sets the run quantum assigned to each eBus client.
    
    Parameters:
    
    quantum - run quantum.
    
    Returns:
    
    this dispatcher builder.
    
    Throws:
    
    IllegalArgumentException - if quantum < 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:
    
    IllegalArgumentException - 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.
  - build
```
public EConfigure.Dispatcher build()
```
    Returns the eBus Dispatcher configuration built from the previously set parameters.
    
    Returns:
    
    an eBus Dispatcher configuration.
    
    Throws:
    
    NullPointerException - if either the Dispatcher name, Dispatcher type, or run queue thread type are not set.
    
    IllegalArgumentException - if the Dispatcher is not marked as default and no classes were provided.

Class EConfigure.DispatcherBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

name

dispatcherType

threadType

spinLimit

parkTime

priority

quantum

numberThreads

isDefault

classes

name

dispatcherType

threadType

spinLimit

parkTime

priority

quantum

numberThreads

isDefault

classes

build