AgentLife (SARL Agent Oriented Programming Language 0.12.0 API)

```
public final class AgentLife
extends Object
```
Describes any information that is required by the SRE for supporting the agent's life.

Since:

0.6.0

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland, Nicolas Gaud

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Constructor Summary

Constructors
Constructor and Description

AgentLife(factories : javax.inject.Provider<Factories>, agentLevelInjector : javax.inject.Provider<ConfigurableAgentInjector>)
Constructor.

Constructors
Constructor and Description
`AgentLife(factories : javax.inject.Provider<Factories>, agentLevelInjector : javax.inject.Provider<ConfigurableAgentInjector>)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContextReference`	`addExternalContext(context : Context, address : Address)` Add a context in which the agent is located.
`protected void`	`attachAgentToDefaultContext(spawningContext : Context)` Set up the agent in order to be attached properly to its default context.
`protected void`	`detachAgentFromPlatform(listener : EventListener, enclosingContexts : ConcurrentCollection<ContextReference>)` Detach the agent from the platform.
`Address`	`getAddressInInnerDefaultSpace()` Replies the address of the agent into the default space of its inner context.
`Agent`	`getAgent()` Replies the agent associated to this life.
`static AgentLife`	`getAgentLife(agent : Agent, factories : javax.inject.Provider<Factories>, agentLevelInjector : javax.inject.Provider<ConfigurableAgentInjector>)` Replies the data structure that is storing the living data of the agent for the SRE.
`static AgentLife`	`getAgentLifeOrNull(agent : Agent)` Replies the data structure that is storing the living data of the agent for the SRE.
`Logging`	`getAgentLogger()` Replies the agent's logger.
`ContextReference`	`getDefaultContext()` Replies the default context of the agent.
`ConcurrentLinkedDeque<ContextReference>`	`getEnclosingContexts()` Replies all the contexts in which the agent is located, including the default context and the external contexts.
`InternalEventBusCapacity`	`getEventBus(ag : Agent)` Replies the agent's event bus.
`ContextReference`	`getExternalContext(identifier : UUID)` Replies the external context with the given identifier.
`int`	`getExternalContextCount()` Replies the number of external contexts in which the agent is located.
`ConcurrentLinkedDeque<ContextReference>`	`getExternalContexts()` Replies the external contexts in which the agent is located.
`Context`	`getInnerContext(creator : (AgentLife)=>Context)` Replies the inner context reference.
`protected (Agent,Skill)=>void`	`getInternalSkillCallback()` Replies the callback to be run when a skill is attached to the agent.
`AgentState`	`getState()` Replies the agent state.
`ContextReference`	`removeExternalContext(context : Context)` Remove a context in which the agent is located.
`ContextReference`	`removeExternalContext(context : ContextReference)` Remove a context in which the agent is located.
`Agent`	`setAgent(agent : Agent)` Change the agent associated to this life.
`ContextReference`	`setDefaultContext(context : Context, address : Address)` Change the default context of the agent.
`Context`	`setInnerContext(innerContext : Context)` Set the inner context reference.
`AgentState`	`setState(state : AgentState)` Change the agent state.
`boolean`	`start(startingAgent : Agent, skillUninstaller : SkillUninstaller, logger : Logger, spawningAgent : UUID, spawningContext : Context, initializationParameters : Object*)` Start the agent's life.
`ConcurrentCollection<ContextReference>`	`stop(dyingAgent : Agent, skillUninstaller : SkillUninstaller, logger : Logger, [fireDestroy : boolean])` Stop the agent's life.
`String`	`toString()`

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

- Constructor Detail
  - AgentLife
```
public new(factories : javax.inject.Provider<Factories>,
           agentLevelInjector : javax.inject.Provider<ConfigurableAgentInjector>)
```
    Constructor.
    
    Parameters:
    
    factories - the provider of factories tool.
    
    agentLevelInjector - the initializer of the agent trait.
- Method Detail
  - getAgentLife
```
@Pure
public static def getAgentLife(agent : Agent,
                                     factories : javax.inject.Provider<Factories>,
                                     agentLevelInjector : javax.inject.Provider<ConfigurableAgentInjector>) : AgentLife 
```
    Description copied from class: AgentLife
    
    Replies the data structure that is storing the living data of the agent for the SRE. If this data structure does not exists, it is automatically created.
    
    Parameters:
    
    agent - the instance of the agent for which the life description should be retrieved
    
    factories - the provider of factories tool.
    
    agentLevelInjector - the injector that must be used for injecting members into an agent.
    
    See Also:
    
    AgentLife.getAgentLifeOrNull(io.sarl.lang.core.Agent)
  - getAgentLifeOrNull
```
@Pure
public static def getAgentLifeOrNull(agent : Agent) : AgentLife 
```
    Description copied from class: AgentLife
    
    Replies the data structure that is storing the living data of the agent for the SRE. If this data structure does not exists, it is NOT created.
    
    Parameters:
    
    agent - the instance of the agent for which the life description should be retrieved
    
    Since:
    
    0.10
    
    See Also:
    
    AgentLife.getAgentLife(io.sarl.lang.core.Agent, javax.inject.Provider<io.sarl.sre.internal.Factories>, javax.inject.Provider<io.sarl.sre.internal.ConfigurableAgentInjector>)
  - toString
```
@Pure
public def toString() : String 
```
    Overrides:
    
    toString in class Object
  - getAgentLogger
```
@Pure
public final def getAgentLogger() : Logging 
```
    Description copied from class: AgentLife
    
    Replies the agent's logger.
    
    Returns:
    
    the logger.
  - getEventBus
```
@Pure
public final def getEventBus(ag : Agent) : InternalEventBusCapacity 
```
    Description copied from class: AgentLife
    
    Replies the agent's event bus.
    
    Parameters:
    
    ag - is the reference to the owner to consider
    
    Returns:
    
    the event bus.
  - getInternalSkillCallback
```
@Pure
protected def getInternalSkillCallback() : (Agent,Skill)=>void 
```
    Description copied from class: AgentLife
    
    Replies the callback to be run when a skill is attached to the agent.
  - start
```
public def start(startingAgent : Agent,
                 skillUninstaller : SkillUninstaller,
                 logger : Logger,
                 spawningAgent : UUID,
                 spawningContext : Context,
                 initializationParameters : Object*) : boolean 
```
    Description copied from class: AgentLife
    
    Start the agent's life.
    This function is invoked for executing the born stage of the agent.
    If an exception is thrown into the initialization code of the agent, the exception is forwarded.
    
    Parameters:
    
    startingAgent - is the reference to the starting agent.
    
    skillUninstaller - the skill uninstaller.
    
    logger - the logger to use for reporting initialization errors when the agent's logger is unavailable
    
    startError - the exception that avoid to start the agent.
    
    spawningAgent - the identifier of the agent which has spawn this starting agent. This agent could be outside the spawningContext. If null, the root agent (Janus kernel) is assumed.
    
    spawningContext - the context in which the agent is spawned.
    
    initializationParameters - the parameters to give to the agent for its start-up.
    
    Returns:
    
    true is successful, i.e. the AgentSpawned could be fired.
  - attachAgentToDefaultContext
```
protected def attachAgentToDefaultContext(spawningContext : Context) : void 
```
    Description copied from class: AgentLife
    
    Set up the agent in order to be attached properly to its default context.
    
    Parameters:
    
    spawningContext - the context in which the agent is spawn.
    
    eventBus - the event bus of the agent.
    
    Since:
    
    0.12
  - detachAgentFromPlatform
```
protected def detachAgentFromPlatform(listener : EventListener,
                                      enclosingContexts : ConcurrentCollection<ContextReference>) : void 
```
    Description copied from class: AgentLife
    
    Detach the agent from the platform.
    This function removes the agent from the default space of its default context.
    
    Parameters:
    
    listener - the listener on space events that must be unregistered.
    
    enclosingContexts - is the list of context for which we should be sure that the agent is out.
  - stop
```
public def stop(dyingAgent : Agent,
                skillUninstaller : SkillUninstaller,
                logger : Logger,
                [fireDestroy : boolean]) : ConcurrentCollection<ContextReference> 
```
    Description copied from class: AgentLife
    
    Stop the agent's life.
    This function is invoked for executing the killing stage of the agent.
    
    Parameters:
    
    dyingAgent - is the agent to be killed.
    
    skillUninstaller - the skill uninstaller.
    
    logger - the logger to use for reporting initialization errors when the agent's logger is unavailable
    
    fireDestroy - indicates if the Destroy event should be fired.
    
    Returns:
    
    the contexts from which the agent was removed.
  - getAgent
```
@Pure
public def getAgent() : Agent 
```
    Description copied from class: AgentLife
    
    Replies the agent associated to this life.
  - setAgent
```
public def setAgent(agent : Agent) : Agent 
```
    Description copied from class: AgentLife
    
    Change the agent associated to this life.
  - getState
```
@Pure
public def getState() : AgentState 
```
    Description copied from class: AgentLife
    
    Replies the agent state.
  - setState
```
public def setState(state : AgentState) : AgentState 
```
    Description copied from class: AgentLife
    
    Change the agent state.
  - setInnerContext
```
public def setInnerContext(innerContext : Context) : Context 
```
    Description copied from class: AgentLife
    
    Set the inner context reference.
    
    Parameters:
    
    innerContext - the instance of inner context, or null
    
    Returns:
    
    the previous context, or null.
  - getInnerContext
```
@Pure
public def getInnerContext(creator : (AgentLife)=>Context) : Context 
```
    Description copied from class: AgentLife
    
    Replies the inner context reference.
    
    Parameters:
    
    creator - is invoked to create the inner context thread-safely. If is it null, the context will not be created on-the-fly if it is not already known.
    
    Returns:
    
    the instance of inner context, or null
  - getAddressInInnerDefaultSpace
```
@Pure
public def getAddressInInnerDefaultSpace() : Address 
```
    Description copied from class: AgentLife
    
    Replies the address of the agent into the default space of its inner context.
    
    Returns:
    
    the address, never null.
  - addExternalContext
```
public def addExternalContext(context : Context,
                              address : Address) : ContextReference 
```
    Description copied from class: AgentLife
    
    Add a context in which the agent is located.
    
    Parameters:
    
    context - the context in which the agent is now located.
    
    address - the address of the agent in the default space of the given context.
    
    Returns:
    
    the created reference, or null if the reference cannot be added (because the given context is already the default context).
  - removeExternalContext
```
public def removeExternalContext(context : Context) : ContextReference 
```
    Description copied from class: AgentLife
    
    Remove a context in which the agent is located.
  - removeExternalContext
```
public def removeExternalContext(context : ContextReference) : ContextReference 
```
    Description copied from class: AgentLife
    
    Remove a context in which the agent is located.
  - getExternalContexts
```
@Pure
public def getExternalContexts() : ConcurrentLinkedDeque<ContextReference> 
```
    Description copied from class: AgentLife
    
    Replies the external contexts in which the agent is located. The default context is not part of the replied collection.
    
    See Also:
    
    #getEnclosingContexts()}
  - getExternalContextCount
```
@Pure
public def getExternalContextCount() : int 
```
    Description copied from class: AgentLife
    
    Replies the number of external contexts in which the agent is located. The default context is not counted.
    
    Returns:
    
    the number of external contexts.
  - getEnclosingContexts
```
@Pure
public def getEnclosingContexts() : ConcurrentLinkedDeque<ContextReference> 
```
    Description copied from class: AgentLife
    
    Replies all the contexts in which the agent is located, including the default context and the external contexts.
    
    See Also:
    
    #getExternalContexts()}
  - getExternalContext
```
@Pure
public def getExternalContext(identifier : UUID) : ContextReference 
```
    Description copied from class: AgentLife
    
    Replies the external context with the given identifier.
    
    Parameters:
    
    identifer - the identifier of the context.
    
    Returns:
    
    the context, or null
  - setDefaultContext
```
public def setDefaultContext(context : Context,
                             address : Address) : ContextReference 
```
    Description copied from class: AgentLife
    
    Change the default context of the agent.
    
    Parameters:
    
    context - the next context, never null.
    
    address - the address of the agent into the default space of the given context.
    
    Returns:
    
    the reference to the previous default context.
  - getDefaultContext
```
@Pure
public def getDefaultContext() : ContextReference 
```
    Description copied from class: AgentLife
    
    Replies the default context of the agent.
    
    Returns:
    
    the default context, never null.

Class AgentLife

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AgentLife

Method Detail

getAgentLife

getAgentLifeOrNull

toString

getAgentLogger

getEventBus

getInternalSkillCallback

start

attachAgentToDefaultContext

detachAgentFromPlatform

stop

getAgent

setAgent

getState

setState

setInnerContext

getInnerContext

getAddressInInnerDefaultSpace

addExternalContext

removeExternalContext

removeExternalContext

getExternalContexts

getExternalContextCount

getEnclosingContexts

getExternalContext

setDefaultContext

getDefaultContext