InnerContextSkill (SARL Agent Oriented Programming Language 0.10.0 API)

java.lang.Object
- io.sarl.lang.core.SRESpecificDataContainer
- - io.sarl.lang.core.AgentProtectedAPIObject
  - - io.sarl.lang.core.AgentTrait
    - - io.sarl.lang.core.Skill
      - io.janusproject.kernel.bic.BuiltinSkill
        
        io.janusproject.kernel.bic.InnerContextSkill

All Implemented Interfaces:

InnerContextAccess, Capacity
```
public class InnerContextSkill
extends BuiltinSkill
implements InnerContextAccess
```
Janus implementation of SARL's InnerContextSkill built-in capacity.

Version:

0.10.0 2019-10-26 19:44:29

Author:

Sebastian Rodriguez, Nicolas Gaud, Stéphane Galland

Maven Group Id:

io.janusproject

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary
- Nested classes/interfaces inherited from class io.sarl.lang.core.Skill
  Skill.UninstallationStage

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AgentContext`	`getInnerContext()` Replies the inner context.
`protected AgentContext`	`getInnerContextWithoutAutomaticCreation()` Replies the inner context, but do not create one if it was not created before calling this function.
`int`	`getInstallationOrder()` Deprecated. since 0.10
`protected InternalEventBusCapacity`	`getInternalEventBusCapacitySkill()` Replies the InternalEventBusCapacity skill as fast as possible.
`ReadWriteLock`	`getLock()` Replies the synchronization lock for the inner context.
`int`	`getMemberAgentCount()` Replies the number of agents that are members of the inner context of the calling agent.
`SynchronizedIterable<UUID>`	`getMemberAgents()` Replies all the member agents in the inner context.
`boolean`	`hasInnerContext()` Replies if the inner context was instanciated.
`boolean`	`hasMemberAgent()` Replies if the calling agent has other agents as members of its inner context.
`boolean`	`isInInnerDefaultSpace(event : Event)` Replies if the given event was emitted in the default space of the inner context.
`boolean`	`isInnerDefaultSpace(space : Space)` Replies if the given space is the default space of the inner context.
`boolean`	`isInnerDefaultSpace(spaceID : SpaceID)` Replies if the given identifier is the identifier of the default space of the inner context.
`boolean`	`isInnerDefaultSpace(spaceID : UUID)` Replies if the given identifier is the identifier of the default space of the inner context.
`void`	`setContextSpaceService(contextService : ContextSpaceService)` Change the reference to the service that is managing the contexts and the spaces.
`void`	`setLockProvider(provider : com.google.inject.Provider<ReadWriteLock>)` Change the provider of the synchronization locks for the inner context.
`void`	`toString(builder : org.eclipse.xtext.xbase.lib.util.ToStringBuilder)` fill the given builder with the string representation of this object.
`protected void`	`uninstall(stage : Skill.UninstallationStage)` This method is called just before uninstalling the skill from its owner agent.

Methods inherited from class io.janusproject.kernel.bic.BuiltinSkill
installationOrder

Methods inherited from class io.sarl.lang.core.Skill
getCaller, install, uninstall

Methods inherited from class io.sarl.lang.core.AgentTrait
clearSkill, getID, getOwner, getSkill, hasSkill, isFromMe, isMe, isMe, operator_mappedTo, setSkill

Methods inherited from class io.sarl.lang.core.AgentProtectedAPIObject
toString

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

- Method Detail
  - setContextSpaceService
```
@Inject
public final def setContextSpaceService(contextService : ContextSpaceService) : void 
```
    Description copied from class: InnerContextSkill
    
    Change the reference to the service that is managing the contexts and the spaces.
    
    Parameters:
    
    contextService - the service.
  - setLockProvider
```
@Inject
public final def setLockProvider(provider : com.google.inject.Provider<ReadWriteLock>) : void 
```
    Description copied from class: InnerContextSkill
    
    Change the provider of the synchronization locks for the inner context.
    
    Parameters:
    
    provider - the provider of locks.
  - getLock
```
public final def getLock() : ReadWriteLock 
```
    Description copied from class: InnerContextSkill
    
    Replies the synchronization lock for the inner context.
    
    Returns:
    
    the lock
  - getInternalEventBusCapacitySkill
```
protected final def getInternalEventBusCapacitySkill() : InternalEventBusCapacity 
```
    Description copied from class: InnerContextSkill
    
    Replies the InternalEventBusCapacity skill as fast as possible.
    
    Returns:
    
    the skill
  - getInstallationOrder
```
@Deprecated
public def getInstallationOrder() : int 
```
    Deprecated. since 0.10
    
    Description copied from class: InnerContextSkill
    
    Replies the installation order of the builtin skill.
    
    Specified by:
    
    getInstallationOrder in class BuiltinSkill
    
    Returns:
    
    the order.
  - hasInnerContext
```
public def hasInnerContext() : boolean 
```
    Description copied from class: InnerContextSkill
    
    Replies if the inner context was instanciated. To create the inner context, call InnerContextSkill.getInnerContext()
    
    Returns:
    
    true if an instance of inner context exists, otherwise false.
  - toString
```
@Pure
public def toString(builder : org.eclipse.xtext.xbase.lib.util.ToStringBuilder) : void 
```
    Description copied from class: AgentProtectedAPIObject
    
    fill the given builder with the string representation of this object.
    
    Overrides:
    
    toString in class AgentTrait
    
    Parameters:
    
    builder - the string builder.
  - uninstall
```
protected def uninstall(stage : Skill.UninstallationStage) : void 
```
    Description copied from class: Skill
    
    This method is called just before uninstalling the skill from its owner agent.
    
    Overrides:
    
    uninstall in class Skill
    
    Parameters:
    
    stage - indicates the stage in the uninstallation process.
  - getInnerContextWithoutAutomaticCreation
```
protected final def getInnerContextWithoutAutomaticCreation() : AgentContext 
```
    Description copied from class: InnerContextSkill
    
    Replies the inner context, but do not create one if it was not created before calling this function. If you would like to automatically create the inner context, please call InnerContextSkill.getInnerContext().
    This function is thread-safe.
    
    Returns:
    
    the inner context, or null.
    
    Since:
    
    0.10
    
    See Also:
    
    InnerContextSkill.getInnerContext()
  - getInnerContext
```
public def getInnerContext() : AgentContext 
```
    Description copied from interface: InnerContextAccess
    
    Replies the inner context.
    
    Specified by:
    
    getInnerContext in interface InnerContextAccess
    
    Returns:
    
    the instanceof the internal agent context.
  - hasMemberAgent
```
public def hasMemberAgent() : boolean 
```
    Description copied from interface: InnerContextAccess
    
    Replies if the calling agent has other agents as members of its inner context. A member agent is an agent which is not the calling agent, and is a member of at least one space of the inner context.
    
    Specified by:
    
    hasMemberAgent in interface InnerContextAccess
    
    Returns:
    
    true if the current agent has other agents as member of its internal context; otherwise false
  - getMemberAgentCount
```
public def getMemberAgentCount() : int 
```
    Description copied from interface: InnerContextAccess
    
    Replies the number of agents that are members of the inner context of the calling agent. A member agent is an agent which is not the calling agent, and is a member of at least one space of the inner context.
    The replied number includes the current agent. Indeed, the current agent is member of its internal context with the role of super-holon.
    
    Specified by:
    
    getMemberAgentCount in interface InnerContextAccess
    
    Returns:
    
    the number of members in the internal context of the current agent.
  - getMemberAgents
```
public def getMemberAgents() : SynchronizedIterable<UUID> 
```
    Description copied from interface: InnerContextAccess
    
    Replies all the member agents in the inner context. A member agent is an agent which is not the calling agent, and is a member of at least one space of the inner context.
    
    Specified by:
    
    getMemberAgents in interface InnerContextAccess
    
    Returns:
    
    the identifiers of the members of the internal context of the current agent.
  - isInnerDefaultSpace
```
public def isInnerDefaultSpace(space : Space) : boolean 
```
    Description copied from interface: InnerContextAccess
    
    Replies if the given space is the default space of the inner context.
    
    Specified by:
    
    isInnerDefaultSpace in interface InnerContextAccess
    
    Parameters:
    
    space - the space to test.
    
    Returns:
    
    true if the given space is the default space of the inner context. Otherwise false.
  - isInnerDefaultSpace
```
public def isInnerDefaultSpace(spaceID : SpaceID) : boolean 
```
    Description copied from interface: InnerContextAccess
    
    Replies if the given identifier is the identifier of the default space of the inner context.
    
    Specified by:
    
    isInnerDefaultSpace in interface InnerContextAccess
    
    Parameters:
    
    spaceID - the identifier to test.
    
    Returns:
    
    true if the given identifier is the identifier of the default space of the inner context. Otherwise false.
  - isInnerDefaultSpace
```
public def isInnerDefaultSpace(spaceID : UUID) : boolean 
```
    Description copied from interface: InnerContextAccess
    
    Replies if the given identifier is the identifier of the default space of the inner context.
    
    Specified by:
    
    isInnerDefaultSpace in interface InnerContextAccess
    
    Parameters:
    
    spaceID - the identifier to test.
    
    Returns:
    
    true if the given identifier is the identifier of the default space of the inner context. Otherwise false.
  - isInInnerDefaultSpace
```
public def isInInnerDefaultSpace(event : Event) : boolean 
```
    Description copied from interface: InnerContextAccess
    
    Replies if the given event was emitted in the default space of the inner context.
    
    Specified by:
    
    isInInnerDefaultSpace in interface InnerContextAccess
    
    Parameters:
    
    event - the event to test.
    
    Returns:
    
    true if the given event was emitted in the default space of the inner context. Otherwise false.

Class InnerContextSkill

Nested Class Summary

Nested classes/interfaces inherited from class io.sarl.lang.core.Skill

Method Summary

Methods inherited from class io.janusproject.kernel.bic.BuiltinSkill

Methods inherited from class io.sarl.lang.core.Skill

Methods inherited from class io.sarl.lang.core.AgentTrait

Methods inherited from class io.sarl.lang.core.AgentProtectedAPIObject

Methods inherited from class java.lang.Object

Method Detail

setContextSpaceService

setLockProvider

getLock

getInternalEventBusCapacitySkill

getInstallationOrder

hasInnerContext

toString

uninstall

getInnerContextWithoutAutomaticCreation

getInnerContext

hasMemberAgent

getMemberAgentCount

getMemberAgents

isInnerDefaultSpace

isInnerDefaultSpace

isInnerDefaultSpace

isInInnerDefaultSpace