io.sarl.lang.core

Class SREutils

java.lang.Object

io.sarl.lang.core.SREutils

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:

0.10.0 2019-10-26 19:44:18

Author:

Stéphane Galland

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Private API

Method Summary

Modifier and Type	Method and Description
static <S extends Capacity> S	castInternalSkillReference(agent : Agent, reference : ClearableReference<Skill>, type : Class<S>) Casts the internal skill reference of an agent.
static ClearableReference<Skill>	createSkillMapping(agent : Agent, capacity : Class<? extends Capacity>, skill : Skill) Deprecated. since 0.10, no replacement
static ClearableReference<Skill>	createSkillMappingGetOld(agent : Agent, capacity : Class<? extends Capacity>, skill : Skill) Deprecated. since 0.10, no replacement
static void	doSkillInstallation(skill : Skill) Do the installation of the given skill.
static void	doSkillUninstallation(skill : Skill, stage : Skill.UninstallationStage) Do the uninstallation of the given skill.
static <S extends Capacity> S	getInternalSkill(agent : Agent, type : Class<S>) Replies the internal skill of an agent.
static ClearableReference<Skill>	getInternalSkillReference(agent : Agent, type : Class<? extends Capacity>) Replies the internal skill reference of an agent.
static ConcurrentMap<Class<? extends Capacity>,ClearableReference<Skill>>	getSkillRepository(agent : Agent) Replies the skill repository of the given agent.
static <S> S	getSreSpecificData(container : SRESpecificDataContainer, type : Class<S>) Replies the data associated to the container by the SRE.
static void	setDynamicSkillProvider(agent : Agent, provider : DynamicSkillProvider) Change the dynamic skill provider of an agent.
static ClearableReference<Skill>	setInternalSkill(agent : Agent, skill : Skill, capacities : Class<? extends Capacity>[]) Set the internal skill of an agent.
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(agent : Agent,
                                                  type : Class<? extends Capacity>) : ClearableReference<Skill> 

Description copied from class: SREutils

Replies the internal skill reference of an agent.

Parameters:

agent - the agent.

type - the type of the capacity.

Returns:

the skill reference

Throws:

UnimplementedCapacityException - if the agent has not a skill for the given capacity.

Since:

0.6

castInternalSkillReference

@Pure
public static def castInternalSkillReference(agent : Agent,
                                                   reference : ClearableReference<Skill>,
                                                   type : Class<S>) : S  with <S extends Capacity> 

Description copied from class: SREutils

Casts the internal skill reference of an agent.

Type Parameters:

S - the type of the capacity.

Parameters:

agent - the agent.

reference - the reference to cast.

type - the type of the capacity.

Returns:

the skill reference

Throws:

UnimplementedCapacityException - if the agent has not a skill for the given capacity.

Since:

0.6

setInternalSkill

public static def setInternalSkill(agent : Agent,
                                   skill : Skill,
                                   capacities : Class<? extends Capacity>[]) : ClearableReference<Skill> 

Description copied from class: SREutils

Set the internal skill of an agent.

Parameters:

agent - the agent.

skill - the skill instance to attach to the agent.

capacities - the list of implemented capacities. This array cannot be null.

Returns:

the reference to the skill.

Since:

0.10

getInternalSkill

@Pure
public static def getInternalSkill(agent : Agent,
                                         type : Class<S>) : S  with <S extends Capacity> 

Description copied from class: SREutils

Replies the internal skill of an agent.

Type Parameters:

S - the type of the capacity.

Parameters:

agent - the agent.

type - the type of the capacity.

Returns:

the skill.

Throws:

UnimplementedCapacityException - if the agent has not a skill for the given capacity.

Since:

0.6

createSkillMapping

@Deprecated
public static def createSkillMapping(agent : Agent,
                                                 capacity : Class<? extends Capacity>,
                                                 skill : Skill) : ClearableReference<Skill> 

Deprecated. since 0.10, no replacement

Description copied from class: SREutils

Create the mapping between the capacity and the skill.

This function does not call neither Skill.install() nor AgentTrait.setOwner(Agent).

Parameters:

agent - the agent.

capacity - the capacity to map.

skill - the skill to map.

Returns:

the created mapping, never null.

Since:

0.6

See Also:

SREutils.createSkillMappingGetOld(Agent, Class, Skill)

createSkillMappingGetOld

@Deprecated
public static def createSkillMappingGetOld(agent : Agent,
                                                       capacity : Class<? extends Capacity>,
                                                       skill : Skill) : ClearableReference<Skill> 

Deprecated. since 0.10, no replacement

Description copied from class: SREutils

Create the mapping between the capacity and the skill.

This function does not call neither Skill.install() nor AgentTrait.setOwner(Agent).

Parameters:

agent - the agent.

capacity - the capacity to map.

skill - the skill to map.

Returns:

the mapping that is defined before the one created by the call to this function, or null if there is no previous mapping.

Since:

0.6

See Also:

SREutils.createSkillMapping(Agent, Class, Skill)

getSkillRepository

public static def getSkillRepository(agent : Agent) : ConcurrentMap<Class<? extends Capacity>,ClearableReference<Skill>> 

Description copied from class: SREutils

Replies the skill repository of the given agent.

The replied repository is not protected against asynchronous accesses.

Parameters:

agent - the agent.

Returns:

the repository.

Since:

0.6

setDynamicSkillProvider

public static def setDynamicSkillProvider(agent : Agent,
                                          provider : DynamicSkillProvider) : void 

Description copied from class: SREutils

Change the dynamic skill provider of an agent.

Parameters:

agent - the agent.

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

doSkillUninstallation

public static def doSkillUninstallation(skill : Skill,
                                        stage : Skill.UninstallationStage) : void 

Description copied from class: SREutils

Do the uninstallation of the given skill.

This function invokes Skill.uninstall(UninstallationStage) and nothing more.

Parameters:

skill - the skill to be uninstalled.

stage - the uninstallation stage, never null.

Since:

0.6