ExecutorsConfig (SARL Agent Oriented Programming Language 0.12.0 API)

```
public class ExecutorsConfig
extends Object
```
Configuration for the parallel executors.

Since:

0.8

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`INTERNAL_ERROR_VERBOSE_LEVEL_NAME` Name of the property for the default verbosity level of the executor's internal errors.
`static Level`	`INTERNAL_ERROR_VERBOSE_LEVEL_VALUE` The default verbosity level of the executor's internal errors.
`static String`	`MAX_NUMBER_OF_THREADS_IN_EXECUTOR_NAME` Name of property for the maximal number of threads to keep in the pool.
`static int`	`MAX_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE` Indicates the maximal number of threads to keep in the pool.
`static String`	`MIN_NUMBER_OF_THREADS_IN_EXECUTOR_NAME` Name of the property for the minimal number of threads to keep in the pool, even if they are idle.
`static int`	`MIN_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE` Indicates the minimal number of threads to keep in the pool, even if they are idle.
`static String`	`PERIODIC_THREAD_POOL_PURGE_NAME` Name of the property that indicates if the executor service is purging the thread queues periodically.
`static boolean`	`PERIODIC_THREAD_POOL_PURGE_VALUE` The default flag that indicates if the executor service is purging the thread queues periodically.
`static String`	`PREFIX` Prefix for the configuration entries of the parallel execution configuration.
`static String`	`THREAD_KEEP_ALIVE_DURATION_NAME` Name of the property for the duration for keeping the iddle threads alive (in seconds).
`static int`	`THREAD_KEEP_ALIVE_DURATION_VALUE` Indicates the duration for keeping the iddle threads alive (in seconds).
`static String`	`THREAD_TIMEOUT_NAME` Name of the property for the numbers of seconds that the kernel is waiting for thread terminations before timeout.
`static int`	`THREAD_TIMEOUT_VALUE` Indicates the numbers of seconds that the kernel is waiting for thread terminations before timeout.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Level`	`getInternalErrorVerboseLevel()` Replies the verbosity level of the internal errors.
`int`	`getKeepAliveDuration()`
`int`	`getMaxThreads()` Replies the maximum number of threads that could be used by the executor service.
`int`	`getMinThreads()`
`int`	`getTimeout()`
`boolean`	`hasMaxThreadsSpecified()` Replies if the maximum number of threads is specified.
`boolean`	`isPeriodicThreadPoolPurge()`
`void`	`setInternalErrorVerboseLevel(level : Level)` Change the verbosity level of the internal errors.
`int`	`setKeepAliveDuration(duration : int)` Change the duration during which a thread is still in memory without being used for another task.
`void`	`setMaxThreads(iMaxThreads : int)` Change the maximum number of threads that could be used by the executor service.
`int`	`setMinThreads(iMinThreads : int)` Change the minimum number of threads that could be used by the executor service.
`void`	`setPeriodicThreadPoolPurge(purge : boolean)` Change the verbosity level of the internal errors.
`int`	`setTimeout(duration : int)` Change the timeout duration for waiting the termination of the threads.

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

- Field Detail
  - PREFIX
```
public static val PREFIX : String
```
    Description copied from class: ExecutorsConfig
    
    Prefix for the configuration entries of the parallel execution configuration.
    
    See Also:
    
    Constant Field Values
  - MAX_NUMBER_OF_THREADS_IN_EXECUTOR_NAME
```
public static val MAX_NUMBER_OF_THREADS_IN_EXECUTOR_NAME : String
```
    Description copied from class: ExecutorsConfig
    
    Name of property for the maximal number of threads to keep in the pool.
    
    See Also:
    
    ExecutorsConfig.MAX_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE, Constant Field Values
  - MAX_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE
```
public static val MAX_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE : int
```
    Description copied from class: ExecutorsConfig
    
    Indicates the maximal number of threads to keep in the pool.
    
    See Also:
    
    ExecutorsConfig.MAX_NUMBER_OF_THREADS_IN_EXECUTOR_NAME, Constant Field Values
  - MIN_NUMBER_OF_THREADS_IN_EXECUTOR_NAME
```
public static val MIN_NUMBER_OF_THREADS_IN_EXECUTOR_NAME : String
```
    Description copied from class: ExecutorsConfig
    
    Name of the property for the minimal number of threads to keep in the pool, even if they are idle.
    
    See Also:
    
    ExecutorsConfig.MIN_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE, Constant Field Values
  - MIN_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE
```
public static val MIN_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE : int
```
    Description copied from class: ExecutorsConfig
    
    Indicates the minimal number of threads to keep in the pool, even if they are idle.
    
    See Also:
    
    ExecutorsConfig.MIN_NUMBER_OF_THREADS_IN_EXECUTOR_NAME, Constant Field Values
  - THREAD_KEEP_ALIVE_DURATION_NAME
```
public static val THREAD_KEEP_ALIVE_DURATION_NAME : String
```
    Description copied from class: ExecutorsConfig
    
    Name of the property for the duration for keeping the iddle threads alive (in seconds).
    
    Since:
    
    0.5.0
    
    See Also:
    
    ExecutorsConfig.THREAD_KEEP_ALIVE_DURATION_VALUE, Constant Field Values
  - THREAD_KEEP_ALIVE_DURATION_VALUE
```
public static val THREAD_KEEP_ALIVE_DURATION_VALUE : int
```
    Description copied from class: ExecutorsConfig
    
    Indicates the duration for keeping the iddle threads alive (in seconds).
    
    Since:
    
    0.5.0
    
    See Also:
    
    ExecutorsConfig.THREAD_KEEP_ALIVE_DURATION_NAME, Constant Field Values
  - THREAD_TIMEOUT_NAME
```
public static val THREAD_TIMEOUT_NAME : String
```
    Description copied from class: ExecutorsConfig
    
    Name of the property for the numbers of seconds that the kernel is waiting for thread terminations before timeout.
    
    See Also:
    
    #KERNEL_THREAD_TIMEOUT_VALUE, Constant Field Values
  - THREAD_TIMEOUT_VALUE
```
public static val THREAD_TIMEOUT_VALUE : int
```
    Description copied from class: ExecutorsConfig
    
    Indicates the numbers of seconds that the kernel is waiting for thread terminations before timeout.
    
    See Also:
    
    #KERNEL_THREAD_TIMEOUT_NAME, Constant Field Values
  - INTERNAL_ERROR_VERBOSE_LEVEL_NAME
```
public static val INTERNAL_ERROR_VERBOSE_LEVEL_NAME : String
```
    Description copied from class: ExecutorsConfig
    
    Name of the property for the default verbosity level of the executor's internal errors.
    
    See Also:
    
    ExecutorsConfig.INTERNAL_ERROR_VERBOSE_LEVEL_VALUE, Constant Field Values
  - INTERNAL_ERROR_VERBOSE_LEVEL_VALUE
```
public static val INTERNAL_ERROR_VERBOSE_LEVEL_VALUE : Level
```
    Description copied from class: ExecutorsConfig
    
    The default verbosity level of the executor's internal errors.
    
    See Also:
    
    ExecutorsConfig.INTERNAL_ERROR_VERBOSE_LEVEL_NAME
  - PERIODIC_THREAD_POOL_PURGE_NAME
```
public static val PERIODIC_THREAD_POOL_PURGE_NAME : String
```
    Description copied from class: ExecutorsConfig
    
    Name of the property that indicates if the executor service is purging the thread queues periodically.
    
    Since:
    
    0.11
    
    See Also:
    
    ExecutorsConfig.PERIODIC_THREAD_POOL_PURGE_VALUE, Constant Field Values
  - PERIODIC_THREAD_POOL_PURGE_VALUE
```
public static val PERIODIC_THREAD_POOL_PURGE_VALUE : boolean
```
    Description copied from class: ExecutorsConfig
    
    The default flag that indicates if the executor service is purging the thread queues periodically.
    
    Since:
    
    0.11
    
    See Also:
    
    ExecutorsConfig.PERIODIC_THREAD_POOL_PURGE_NAME, Constant Field Values
- Method Detail
  - setMaxThreads
```
public def setMaxThreads(iMaxThreads : int) : void 
```
    Description copied from class: ExecutorsConfig
    
    Change the maximum number of threads that could be used by the executor service.
    
    Parameters:
    
    maxThreads - the max number.
  - getMaxThreads
```
@Pure
public def getMaxThreads() : int 
```
    Description copied from class: ExecutorsConfig
    
    Replies the maximum number of threads that could be used by the executor service.
    
    Parameters:
    
    the - max number.
  - hasMaxThreadsSpecified
```
@Pure
public def hasMaxThreadsSpecified() : boolean 
```
    Description copied from class: ExecutorsConfig
    
    Replies if the maximum number of threads is specified.
    
    Returns:
    
    true if the maximum number of threads is specified. Otherwise false.
  - setMinThreads
```
public def setMinThreads(iMinThreads : int) : int 
```
    Description copied from class: ExecutorsConfig
    
    Change the minimum number of threads that could be used by the executor service.
    
    Parameters:
    
    minThreads - the min number.
  - setKeepAliveDuration
```
public def setKeepAliveDuration(duration : int) : int 
```
    Description copied from class: ExecutorsConfig
    
    Change the duration during which a thread is still in memory without being used for another task.
    
    Parameters:
    
    duration - the duration of an iddle thread.
  - setTimeout
```
public def setTimeout(duration : int) : int 
```
    Description copied from class: ExecutorsConfig
    
    Change the timeout duration for waiting the termination of the threads.
    
    Parameters:
    
    duration - the timeout duration.
  - setInternalErrorVerboseLevel
```
public def setInternalErrorVerboseLevel(level : Level) : void 
```
    Description copied from class: ExecutorsConfig
    
    Change the verbosity level of the internal errors.
  - getInternalErrorVerboseLevel
```
@Pure
public def getInternalErrorVerboseLevel() : Level 
```
    Description copied from class: ExecutorsConfig
    
    Replies the verbosity level of the internal errors.
    
    Returns:
    
    the verbose level
  - setPeriodicThreadPoolPurge
```
public def setPeriodicThreadPoolPurge(purge : boolean) : void 
```
    Description copied from class: ExecutorsConfig
    
    Change the verbosity level of the internal errors.
    
    Since:
    
    0.11
  - getMinThreads
```
@Pure
public def getMinThreads() : int 
```
  - getKeepAliveDuration
```
@Pure
public def getKeepAliveDuration() : int 
```
  - getTimeout
```
@Pure
public def getTimeout() : int 
```
  - isPeriodicThreadPoolPurge
```
@Pure
public def isPeriodicThreadPoolPurge() : boolean 
```

Class ExecutorsConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFIX

MAX_NUMBER_OF_THREADS_IN_EXECUTOR_NAME

MAX_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE

MIN_NUMBER_OF_THREADS_IN_EXECUTOR_NAME

MIN_NUMBER_OF_THREADS_IN_EXECUTOR_VALUE

THREAD_KEEP_ALIVE_DURATION_NAME

THREAD_KEEP_ALIVE_DURATION_VALUE

THREAD_TIMEOUT_NAME

THREAD_TIMEOUT_VALUE

INTERNAL_ERROR_VERBOSE_LEVEL_NAME

INTERNAL_ERROR_VERBOSE_LEVEL_VALUE

PERIODIC_THREAD_POOL_PURGE_NAME

PERIODIC_THREAD_POOL_PURGE_VALUE

Method Detail

setMaxThreads

getMaxThreads

hasMaxThreadsSpecified

setMinThreads

setKeepAliveDuration

setTimeout

setInternalErrorVerboseLevel

getInternalErrorVerboseLevel

setPeriodicThreadPoolPurge

getMinThreads

getKeepAliveDuration

getTimeout

isPeriodicThreadPoolPurge