SREutils (SARL Agent Oriented Programming Language 0.12.0 API)

```
public final class SREutils
extends Object
```
Utilities for accessing to the part of the SARL API that is dedicated to the SARL run-time environments (SRE).
These utilities are provided for enabling the implementation of high-performance SRE by giving storage area into the instances of SARL concepts.
The data that is set and get by the functions in this utility class are SRE-dependent. The instance type of the data is known only by the SRE.
Note that any SRE-specific data stored into a SARL object has the following properties:
- it is transient, i.e. it is not serialized;
- it is used in the implementation of the Object.equals(Object) function;
- it is used in the implementation of the Object.hashCode() function;
- it is used in the implementation of the Object.toString() function.
Since:

0.5

Version:

io.sarl.lang.core 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Private API

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <S extends Capacity> S`	`castInternalSkillReference(container : AbstractSkillContainer, reference : AtomicSkillReference, type : Class<S>)` Casts the internal skill reference of a skill container.
`static void`	`doBehaviorInstallation(behavior : Behavior)` Do the installation of the given behavior.
`static void`	`doBehaviorUninstallation(behavior : Behavior)` Do the uninstallation of the given behavior.
`static void`	`doEvaluateBehaviorGuards(receiver : IBehaviorGuardEvaluatorReceiver, event : Object, behaviorsMethodsToExecute : Collection<Runnable>)` Do the guard evaluations of the behavior units.
`static void`	`doGetSupportedEvents(receiver : IBehaviorGuardEvaluatorReceiver, events : Set<Class<? extends Event>>)` Retrieve the events' types that are supported by the given receiver.
`static boolean`	`doIsSupportedEvent(receiver : IBehaviorGuardEvaluatorReceiver, event : Class<? extends Event>)` Replies if the given event is supported by the given receiver.
`static void`	`doSkillInstallation(skill : Skill)` Do the installation of the given skill.
`static void`	`doSkillUninstallation(skill : Skill)` Do the uninstallation of the given skill.
`static void`	`doSkillUninstallationPreparation(skill : Skill)` Do the uninstallation preparation of the given skill.
`static <S extends Capacity> S`	`getInternalSkill(container : AbstractSkillContainer, type : Class<S>)` Replies the internal skill of a skill container.
`static AtomicSkillReference`	`getInternalSkillReference(container : AbstractSkillContainer, type : Class<? extends Capacity>)` Replies the internal skill reference of a skill container.
`static ConcurrentMap<Class<? extends Capacity>,AtomicSkillReference>`	`getSkillRepository(container : AbstractSkillContainer)` Replies the skill repository of the given container.
`static <S> S`	`getSreSpecificData(container : SRESpecificDataContainer, type : Class<S>)` Replies the data associated to the container by the SRE.
`static void`	`setDynamicSkillProvider(container : AbstractSkillContainer, provider : DynamicSkillProvider)` Change the dynamic skill provider of a skill container.
`static AtomicSkillReference`	`setInternalSkill(container : AbstractSkillContainer, skill : Skill, capacities : Class<? extends Capacity>[])` Set the internal skill of a skill container.
`static AtomicSkillReference`	`setInternalSkillIfAbsent(container : AbstractSkillContainer, skill : Skill, capacities : Class<? extends Capacity>[])` Set the internal skill of a skill container if the skill is not yet mapped.
`static void`	`setSkillInstallationCallback(agent : Agent, callback : (Agent,Skill)=>void)` Provide an agent with a callback function for the skill installation.
`static void`	`setSreSpecificData(container : SRESpecificDataContainer, data : Object)` Change the data associated to the given container by the SRE.
`static <S> S`	`setSreSpecificData(container : SRESpecificDataContainer, data : S, type : Class<S>)` Change the data associated to the given container by the SRE.

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

- Method Detail
  - getSreSpecificData
```
@Pure
public static def getSreSpecificData(container : SRESpecificDataContainer,
                                           type : Class<S>) : S  with <S> 
```
    Description copied from class: SREutils
    
    Replies the data associated to the container by the SRE.
    
    Type Parameters:
    
    S - the type of the data.
    
    Parameters:
    
    type - the type of the data.
    
    container - the container.
    
    Returns:
    
    the SRE-specific data.
  - setSreSpecificData
```
public static def setSreSpecificData(container : SRESpecificDataContainer,
                                     data : Object) : void 
```
    Description copied from class: SREutils
    
    Change the data associated to the given container by the SRE.
    
    Parameters:
    
    container - the container.
    
    data - the SRE-specific data.
  - setSreSpecificData
```
public static def setSreSpecificData(container : SRESpecificDataContainer,
                                     data : S,
                                     type : Class<S>) : S  with <S> 
```
    Description copied from class: SREutils
    
    Change the data associated to the given container by the SRE.
    
    Type Parameters:
    
    S - the type of the data.
    
    Parameters:
    
    type - the type of the data.
    
    container - the container.
    
    data - the SRE-specific data.
    
    Returns:
    
    the SRE-specific data that was associated to the container before associating data to it.
    
    Since:
    
    0.6
  - getInternalSkillReference
```
@Pure
public static def getInternalSkillReference(container : AbstractSkillContainer,
                                                  type : Class<? extends Capacity>) : AtomicSkillReference 
```
    Description copied from class: SREutils
    
    Replies the internal skill reference of a skill container.
    
    Parameters:
    
    container - the container.
    
    type - the type of the capacity.
    
    Returns:
    
    the skill reference
    
    Since:
    
    0.6
  - castInternalSkillReference
```
@Pure
public static def castInternalSkillReference(container : AbstractSkillContainer,
                                                   reference : AtomicSkillReference,
                                                   type : Class<S>) : S  with <S extends Capacity> 
```
    Description copied from class: SREutils
    
    Casts the internal skill reference of a skill container.
    
    Type Parameters:
    
    S - the type of the capacity.
    
    Parameters:
    
    container - the container.
    
    reference - the reference to cast.
    
    type - the type of the capacity.
    
    Returns:
    
    the skill reference
    
    Since:
    
    0.6
  - setInternalSkill
```
public static def setInternalSkill(container : AbstractSkillContainer,
                                   skill : Skill,
                                   capacities : Class<? extends Capacity>[]) : AtomicSkillReference 
```
    Description copied from class: SREutils
    
    Set the internal skill of a skill container.
    
    Parameters:
    
    container - the container.
    
    skill - the skill instance to attach to the container.
    
    capacities - the list of implemented capacities. This array cannot be null.
    
    Returns:
    
    the reference to the skill.
    
    Since:
    
    0.10
  - setInternalSkillIfAbsent
```
public static def setInternalSkillIfAbsent(container : AbstractSkillContainer,
                                           skill : Skill,
                                           capacities : Class<? extends Capacity>[]) : AtomicSkillReference 
```
    Description copied from class: SREutils
    
    Set the internal skill of a skill container if the skill is not yet mapped.
    
    Parameters:
    
    container - the container.
    
    skill - the skill instance to attach to the container.
    
    capacities - the list of implemented capacities. This array cannot be null.
    
    Returns:
    
    the reference to the skill.
    
    Since:
    
    0.11
  - getInternalSkill
```
@Pure
public static def getInternalSkill(container : AbstractSkillContainer,
                                         type : Class<S>) : S  with <S extends Capacity> 
```
    Description copied from class: SREutils
    
    Replies the internal skill of a skill container.
    
    Type Parameters:
    
    S - the type of the capacity.
    
    Parameters:
    
    container - the container.
    
    type - the type of the capacity.
    
    Returns:
    
    the skill.
    
    Since:
    
    0.6
  - getSkillRepository
```
public static def getSkillRepository(container : AbstractSkillContainer) : ConcurrentMap<Class<? extends Capacity>,AtomicSkillReference> 
```
    Description copied from class: SREutils
    
    Replies the skill repository of the given container.
    The replied repository is not protected against asynchronous accesses.
    
    Parameters:
    
    container - the container.
    
    Returns:
    
    the repository.
    
    Since:
    
    0.6
  - setDynamicSkillProvider
```
public static def setDynamicSkillProvider(container : AbstractSkillContainer,
                                          provider : DynamicSkillProvider) : void 
```
    Description copied from class: SREutils
    
    Change the dynamic skill provider of a skill container.
    
    Parameters:
    
    container - the container.
    
    provider - the provider.
    
    Since:
    
    0.6
  - doSkillInstallation
```
public static def doSkillInstallation(skill : Skill) : void 
```
    Description copied from class: SREutils
    
    Do the installation of the given skill.
    This function invokes Skill.install() and nothing more.
    
    Parameters:
    
    skill - the skill to be installed.
    
    Since:
    
    0.6
    
    See Also:
    
    SREutils.doSkillUninstallationPreparation(Skill), SREutils.doSkillUninstallation(Skill)
  - doSkillUninstallationPreparation
```
public static def doSkillUninstallationPreparation(skill : Skill) : void 
```
    Description copied from class: SREutils
    
    Do the uninstallation preparation of the given skill.
    This function invokes Skill.prepareUninstallation() and nothing more.
    
    Parameters:
    
    skill - the skill to be uninstalled.
    
    Since:
    
    0.11
    
    See Also:
    
    SREutils.doSkillInstallation(Skill), SREutils.doSkillUninstallation(Skill)
  - doSkillUninstallation
```
public static def doSkillUninstallation(skill : Skill) : void 
```
    Description copied from class: SREutils
    
    Do the uninstallation of the given skill.
    This function invokes Skill.uninstall() and nothing more.
    
    Parameters:
    
    skill - the skill to be uninstalled.
    
    Since:
    
    0.11
    
    See Also:
    
    SREutils.doSkillInstallation(Skill), SREutils.doSkillUninstallationPreparation(Skill)
  - doEvaluateBehaviorGuards
```
public static def doEvaluateBehaviorGuards(receiver : IBehaviorGuardEvaluatorReceiver,
                                           event : Object,
                                           behaviorsMethodsToExecute : Collection<Runnable>) : void 
```
    Description copied from class: SREutils
    
    Do the guard evaluations of the behavior units.
    
    Parameters:
    
    receiver - is the object that receives the events.
    
    event - is the event that causes the evaluation.
    
    behaviorsMethodsToExecute - receives the behavior unit methods.
    
    Since:
    
    0.12
  - doGetSupportedEvents
```
public static def doGetSupportedEvents(receiver : IBehaviorGuardEvaluatorReceiver,
                                       events : Set<Class<? extends Event>>) : void 
```
    Description copied from class: SREutils
    
    Retrieve the events' types that are supported by the given receiver.
    
    Parameters:
    
    receiver - is the object that receives the events.
    
    events - is the set to fill out with the supported events' types.
    
    Since:
    
    0.12
  - doIsSupportedEvent
```
public static def doIsSupportedEvent(receiver : IBehaviorGuardEvaluatorReceiver,
                                     event : Class<? extends Event>) : boolean 
```
    Description copied from class: SREutils
    
    Replies if the given event is supported by the given receiver.
    
    Parameters:
    
    receiver - is the object that receives the events.
    
    event - is the event to test.
    
    Returns:
    
    true if the event is supported; false otherwise.
    
    Since:
    
    0.12
  - doBehaviorInstallation
```
public static def doBehaviorInstallation(behavior : Behavior) : void 
```
    Description copied from class: SREutils
    
    Do the installation of the given behavior.
    This function invokes Behavior.install() and nothing more.
    
    Parameters:
    
    behavior - the behavior to be installed.
    
    Since:
    
    0.12
    
    See Also:
    
    SREutils.doBehaviorUninstallation(Behavior)
  - doBehaviorUninstallation
```
public static def doBehaviorUninstallation(behavior : Behavior) : void 
```
    Description copied from class: SREutils
    
    Do the uninstallation of the given behavior.
    This function invokes Behavior.uninstall() and nothing more.
    
    Parameters:
    
    behavior - the behavior to be uninstalled.
    
    Since:
    
    0.12
    
    See Also:
    
    SREutils.doBehaviorInstallation(Behavior)
  - setSkillInstallationCallback
```
public static def setSkillInstallationCallback(agent : Agent,
                                               callback : (Agent,Skill)=>void) : void 
```
    Description copied from class: SREutils
    
    Provide an agent with a callback function for the skill installation.
    
    Parameters:
    
    agent - is the agent to equip.
    
    callback - is the callback to install.
    
    Since:
    
    0.12

Class SREutils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSreSpecificData

setSreSpecificData

setSreSpecificData

getInternalSkillReference

castInternalSkillReference

setInternalSkill

setInternalSkillIfAbsent

getInternalSkill

getSkillRepository

setDynamicSkillProvider

doSkillInstallation

doSkillUninstallationPreparation

doSkillUninstallation

doEvaluateBehaviorGuards

doGetSupportedEvents

doIsSupportedEvent

doBehaviorInstallation

doBehaviorUninstallation

setSkillInstallationCallback