ThreadBuilder (commons-thread 1.0.0 API)

java.lang.Object
- br.com.armange.commons.thread.ThreadBuilder

public class ThreadBuilder
extends java.lang.Object

Useful structure for thread creation in the following scenarios:

Timeout

The thread will be active only until the timeout be fired.
Delay

The thread will be active only after the time delay be completed.
Interval

The thread will be repeated after the time interval be completed.
Exception handling

Handles of uncaught exceptions can be thrown and handled within threads.

Note:
The thread will wait a minimum delay (MINIMAL_REQUIRED_DELAY) if and only if a (setAfterExecuteConsumer(BiConsumer)) or a (setUncaughtExceptionConsumer(Consumer)) is present.

 Example:
 
 final ExecutorService thread = ThreadBuilder
          .newBuilder() //New object to build a new thread.
          .setDelay(1000) //The thread will wait one second before start.
          .setTimeout(4000) //The thread will be canceled after four seconds.
          .setInterval(1000) //The thread will be repeated every second. 
          .setAfterExecuteConsumer(afterExecuteConsumer) //A consumer will be called after thread execution.
          .setUncaughtExceptionConsumer(throwableConsumer) //A consumer will be called after any exception thrown.
          .setMayInterruptIfRunning(true) //The thread interruption/cancellation will not wait execution.
          .setSilentInterruption(true) //Interruption and Cancellation exceptions will not be thrown.
          .setExecution(anyRunnable) //The thread execution.
          .setThreadNameSupplier(() -> "Thread name")
          .setThreadPrioritySupplier(() -> 4)
          .start();

Since:: 2019-11-26 V1.0.0 (JDK 1.8)
See Also:: ScheduledCaughtExecutorService

Field Summary

Fields
Modifier and Type Field and Description

static long MINIMAL_REQUIRED_DELAY
1000 milliseconds as a minimal delay.

Fields
Modifier and Type	Field and Description
`static long`	`MINIMAL_REQUIRED_DELAY` 1000 milliseconds as a minimal delay.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ThreadBuilder`	`newBuilder()`
`static ThreadBuilder`	`newBuilder(int corePoolSize)`
`ThreadBuilder`	`setAfterExecuteConsumer(java.util.function.BiConsumer<java.lang.Runnable,java.lang.Throwable> afterExecuteConsumer)` Sets the consumer to be called after thread execution.
`ThreadBuilder`	`setDelay(long milliseconds)` Sets the delay value.
`ThreadBuilder`	`setExecution(java.lang.Runnable execution)` Sets the thread execution.
`ThreadBuilder`	`setInterval(long milliseconds)` Sets the repeating interval value.
`ThreadBuilder`	`setMayInterruptIfRunning(boolean flag)` Sets the thread-interrupting-flag.
`ThreadBuilder`	`setSilentInterruption(boolean flag)` Sets the thread-silent-interrupting-flag.
`ThreadBuilder`	`setThreadNameSupplier(java.util.function.Supplier<java.lang.String> threadNameSupplier)` Sets the thread name supplier.The thread factory will consume this supplier to generate a thread name before return a new thread.
`ThreadBuilder`	`setThreadPrioritySupplier(java.util.function.Supplier<java.lang.Integer> threadPrioritySupplier)` Sets the thread priority supplier.The thread factory will consume this supplier to generate a thread priority before return a new thread.
`ThreadBuilder`	`setTimeout(long milliseconds)` Sets the timeout value.
`ThreadBuilder`	`setUncaughtExceptionConsumer(java.util.function.Consumer<java.lang.Throwable> uncaughtExceptionConsumer)` Sets the consumer to be called after exception throwing.
`ExecutorResult`	`start()` Starts the thread.
`ThreadBuilder`	`startAndBuildOther()` Starts the thread.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MINIMAL_REQUIRED_DELAY
```
public static final long MINIMAL_REQUIRED_DELAY
```
    1000 milliseconds as a minimal delay.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - newBuilder
```
public static ThreadBuilder newBuilder()
```
    Returns:
    
    a new object to perform a thread creation.
  - newBuilder
```
public static ThreadBuilder newBuilder(int corePoolSize)
```
    Parameters:
    
    corePoolSize - the ScheduledCaughtExecutorService pool size.
    
    Returns:
    
    a new object to perform a thread creation.
    
    See Also:
    
    ScheduledCaughtExecutorService.ScheduledCaughtExecutorService(int)
  - setTimeout
```
public ThreadBuilder setTimeout(long milliseconds)
```
    Sets the timeout value.
    
    Parameters:
    
    milliseconds - the timeout value in milliseconds.
    
    Returns:
    
    the current thread builder.
  - setDelay
```
public ThreadBuilder setDelay(long milliseconds)
```
    Sets the delay value.
    
    Parameters:
    
    milliseconds - the delay value in milliseconds.
    
    Returns:
    
    the current thread builder.
  - setInterval
```
public ThreadBuilder setInterval(long milliseconds)
```
    Sets the repeating interval value.
    
    Parameters:
    
    milliseconds - the repeating interval value in milliseconds.
    
    Returns:
    
    the current thread builder.
  - setAfterExecuteConsumer
```
public ThreadBuilder setAfterExecuteConsumer(java.util.function.BiConsumer<java.lang.Runnable,java.lang.Throwable> afterExecuteConsumer)
```
    Sets the consumer to be called after thread execution.
    
    Parameters:
    
    afterExecuteConsumer - the consumer to be called after thread execution.
    
    Returns:
    
    the current thread builder.
    
    See Also:
    
    ScheduledCaughtExecutorService.afterExecute(Runnable, Throwable)
  - setUncaughtExceptionConsumer
```
public ThreadBuilder setUncaughtExceptionConsumer(java.util.function.Consumer<java.lang.Throwable> uncaughtExceptionConsumer)
```
    Sets the consumer to be called after exception throwing. This consumer will be called as a first after-executes consumer.
    
    Parameters:
    
    uncaughtExceptionConsumer - the consumer to be called after exception throwing.
    
    Returns:
    
    the current thread builder.
  - setThreadNameSupplier
```
public ThreadBuilder setThreadNameSupplier(java.util.function.Supplier<java.lang.String> threadNameSupplier)
```
    Sets the thread name supplier.The thread factory will consume this supplier to generate a thread name before return a new thread.
    
    Parameters:
    
    threadNameSupplier - the thread name supplier.
    
    Returns:
    
    the current thread builder.
  - setThreadPrioritySupplier
```
public ThreadBuilder setThreadPrioritySupplier(java.util.function.Supplier<java.lang.Integer> threadPrioritySupplier)
```
    Sets the thread priority supplier.The thread factory will consume this supplier to generate a thread priority before return a new thread.
    
    Parameters:
    
    threadPrioritySupplier - the thread priority supplier.
    
    Returns:
    
    the current thread builder.
  - setExecution
```
public ThreadBuilder setExecution(java.lang.Runnable execution)
```
    Sets the thread execution.
    
    Parameters:
    
    execution - the thread execution(Runnable)
    
    Returns:
    
    the current thread builder.
  - setMayInterruptIfRunning
```
public ThreadBuilder setMayInterruptIfRunning(boolean flag)
```
    Sets the thread-interrupting-flag.
    
    Parameters:
    
    flag - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete.
    
    Returns:
    
    the current thread builder.
    
    See Also:
    
    Future.cancel(boolean)
  - setSilentInterruption
```
public ThreadBuilder setSilentInterruption(boolean flag)
```
    Sets the thread-silent-interrupting-flag.
    
    Parameters:
    
    flag - true if the Interruption/Cancellation exceptions should be ignored.
    
    Returns:
    
    the current thread builder.
    
    See Also:
    
    Future.cancel(boolean), CancellationException, InterruptedException
  - start
```
public ExecutorResult start()
```
    Starts the thread.
    
    Returns:
    
    the executor's result after starting thread.
    
    See Also:
    
    ExecutorResult
  - startAndBuildOther
```
public ThreadBuilder startAndBuildOther()
```
    Starts the thread.
    
    Returns:
    
    the current thread builder to prepare another thread.

Class ThreadBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MINIMAL_REQUIRED_DELAY

Method Detail

newBuilder

newBuilder

setTimeout

setDelay

setInterval

setAfterExecuteConsumer

setUncaughtExceptionConsumer

setThreadNameSupplier

setThreadPrioritySupplier

setExecution

setMayInterruptIfRunning

setSilentInterruption

start

startAndBuildOther