LifecycleConfig (SARL Agent Oriented Programming Language 0.12.0 API)

```
public class LifecycleConfig
extends Object
```
Configuration for the agent lifecycle management.

Since:

0.11

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`	`AGENT_SPAWNING_COUNT_PER_THREAD_NAME` Name of property that indicates the maximal number of agents that could be spawn by a single thread of the lifecycle service.
`static int`	`AGENT_SPAWNING_COUNT_PER_THREAD_VALUE` Indicates the maximal number of agents that could be spawn by a single thread of the lifecycle service.
`static String`	`CREATE_AGENT_WITH_INJECTOR_NAME` Name of property that indicates if agents must be created by an injector.
`static boolean`	`CREATE_AGENT_WITH_INJECTOR_VALUE` Indicates if the agents must be created with an injector by default.
`static String`	`ENABLE_INJECTABLE_ANNOTATION_NAME` Name of property that indicates if the support of the `@Injectable` is enable when the creation of the agents is not injection based.
`static boolean`	`ENABLE_INJECTABLE_ANNOTATION_VALUE` Indicates if the support of the `@Injectable` is enable when the creation of the agents is not injection based.
`static String`	`EVENT_BUS_TYPE_NAME` Name of property that indicates the type of the event bus to create for each agent.
`static EventBusType`	`EVENT_BUS_TYPE_VALUE` Indicates the type of event bus to create for each agent.
`static String`	`PREFIX` Prefix for the configuration entries of the lifecycle configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAgentSpawningCountPerThread()`
`EventBusType`	`getEventBusType()`
`boolean`	`isCreateAgentsWithInjector()`
`boolean`	`isEnableInjectableSupport()`
`void`	`setAgentSpawningCountPerThread(number : int)` Change the maximal number of agents that could be spawn by a single thread of the lifecycle service.
`void`	`setCreateAgentsWithInjector(useInjector : boolean)` Change the flag that indicates if the agents must be created with injector, or not.
`void`	`setEnableInjectableSupport(enableInjectable : boolean)` Change the flag that indicates the `@Injectable` annotation is supported when the agents are not created with an injector.
`void`	`setEventBusType(type : EventBusType)` Change the type of event bus to be created for each agent.

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: LifecycleConfig
    
    Prefix for the configuration entries of the lifecycle configuration.
    
    See Also:
    
    Constant Field Values
  - CREATE_AGENT_WITH_INJECTOR_NAME
```
public static val CREATE_AGENT_WITH_INJECTOR_NAME : String
```
    Description copied from class: LifecycleConfig
    
    Name of property that indicates if agents must be created by an injector.
    
    See Also:
    
    LifecycleConfig.CREATE_AGENT_WITH_INJECTOR_VALUE, Constant Field Values
  - CREATE_AGENT_WITH_INJECTOR_VALUE
```
public static val CREATE_AGENT_WITH_INJECTOR_VALUE : boolean
```
    Description copied from class: LifecycleConfig
    
    Indicates if the agents must be created with an injector by default.
    
    See Also:
    
    LifecycleConfig.CREATE_AGENT_WITH_INJECTOR_NAME, Constant Field Values
  - ENABLE_INJECTABLE_ANNOTATION_NAME
```
public static val ENABLE_INJECTABLE_ANNOTATION_NAME : String
```
    Description copied from class: LifecycleConfig
    
    Name of property that indicates if the support of the @Injectable is enable when the creation of the agents is not injection based.
    
    Since:
    
    0.12
    
    See Also:
    
    LifecycleConfig.ENABLE_INJECTABLE_ANNOTATION_VALUE, Constant Field Values
  - ENABLE_INJECTABLE_ANNOTATION_VALUE
```
public static val ENABLE_INJECTABLE_ANNOTATION_VALUE : boolean
```
    Description copied from class: LifecycleConfig
    
    Indicates if the support of the @Injectable is enable when the creation of the agents is not injection based.
    
    Since:
    
    0.12
    
    See Also:
    
    LifecycleConfig.ENABLE_INJECTABLE_ANNOTATION_NAME, Constant Field Values
  - AGENT_SPAWNING_COUNT_PER_THREAD_NAME
```
public static val AGENT_SPAWNING_COUNT_PER_THREAD_NAME : String
```
    Description copied from class: LifecycleConfig
    
    Name of property that indicates the maximal number of agents that could be spawn by a single thread of the lifecycle service. This value is used to create threads that are spawning blocks of agents.
    
    Since:
    
    0.11
    
    See Also:
    
    LifecycleConfig.AGENT_SPAWNING_COUNT_PER_THREAD_VALUE, Constant Field Values
  - AGENT_SPAWNING_COUNT_PER_THREAD_VALUE
```
public static val AGENT_SPAWNING_COUNT_PER_THREAD_VALUE : int
```
    Description copied from class: LifecycleConfig
    
    Indicates the maximal number of agents that could be spawn by a single thread of the lifecycle service. This value is used to create threads that are spawning blocks of agents.
    
    Since:
    
    0.11
    
    See Also:
    
    LifecycleConfig.AGENT_SPAWNING_COUNT_PER_THREAD_NAME, Constant Field Values
  - EVENT_BUS_TYPE_NAME
```
public static val EVENT_BUS_TYPE_NAME : String
```
    Description copied from class: LifecycleConfig
    
    Name of property that indicates the type of the event bus to create for each agent.
    
    Since:
    
    0.12
    
    See Also:
    
    LifecycleConfig.EVENT_BUS_TYPE_VALUE, Constant Field Values
  - EVENT_BUS_TYPE_VALUE
```
public static val EVENT_BUS_TYPE_VALUE : EventBusType
```
    Description copied from class: LifecycleConfig
    
    Indicates the type of event bus to create for each agent.
    
    Since:
    
    0.12
    
    See Also:
    
    LifecycleConfig.EVENT_BUS_TYPE_NAME
- Method Detail
  - setEventBusType
```
public def setEventBusType(type : EventBusType) : void 
```
    Description copied from class: LifecycleConfig
    
    Change the type of event bus to be created for each agent.
    
    Parameters:
    
    type - the type of event bus.
    
    Since:
    
    0.12
  - setCreateAgentsWithInjector
```
public def setCreateAgentsWithInjector(useInjector : boolean) : void 
```
    Description copied from class: LifecycleConfig
    
    Change the flag that indicates if the agents must be created with injector, or not.
    
    Parameters:
    
    useInjector - is true if the agents should be created by an injector.
  - setEnableInjectableSupport
```
public def setEnableInjectableSupport(enableInjectable : boolean) : void 
```
    Description copied from class: LifecycleConfig
    
    Change the flag that indicates the @Injectable annotation is supported when the agents are not created with an injector.
    
    Parameters:
    
    enableInjectable - is true if agents ar injected if their are annoted with @Injectable.
    
    Since:
    
    0.12
  - setAgentSpawningCountPerThread
```
public def setAgentSpawningCountPerThread(number : int) : void 
```
    Description copied from class: LifecycleConfig
    
    Change the maximal number of agents that could be spawn by a single thread of the lifecycle service. This value is used to create threads that are spawning blocks of agents.
    
    Parameters:
    
    number - is the number of agent to be spawned.
    
    Since:
    
    0.11
  - isCreateAgentsWithInjector
```
@Pure
public def isCreateAgentsWithInjector() : boolean 
```
  - isEnableInjectableSupport
```
@Pure
public def isEnableInjectableSupport() : boolean 
```
  - getAgentSpawningCountPerThread
```
@Pure
public def getAgentSpawningCountPerThread() : int 
```
  - getEventBusType
```
@Pure
public def getEventBusType() : EventBusType 
```

Class LifecycleConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFIX

CREATE_AGENT_WITH_INJECTOR_NAME

CREATE_AGENT_WITH_INJECTOR_VALUE

ENABLE_INJECTABLE_ANNOTATION_NAME

ENABLE_INJECTABLE_ANNOTATION_VALUE

AGENT_SPAWNING_COUNT_PER_THREAD_NAME

AGENT_SPAWNING_COUNT_PER_THREAD_VALUE

EVENT_BUS_TYPE_NAME

EVENT_BUS_TYPE_VALUE

Method Detail

setEventBusType

setCreateAgentsWithInjector

setEnableInjectableSupport

setAgentSpawningCountPerThread

isCreateAgentsWithInjector

isEnableInjectableSupport

getAgentSpawningCountPerThread

getEventBusType