Context (SARL Agent Oriented Programming Language 0.12.0 API)

java.lang.Object
- io.sarl.lang.core.SRESpecificDataContainer
- - io.sarl.lang.core.AgentProtectedAPIObject
  - - io.sarl.lang.core.AgentTrait
    - - io.sarl.sre.services.context.Context

All Implemented Interfaces:

AgentContext
```
public class Context
extends AgentTrait
implements AgentContext
```
Implementation of an agent context in the SRE platform.
This class is thread-safe.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Sebastian Rodriguez, Nicolas Gaud, Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Constructor Summary

Constructors
Constructor and Description
`Context(id : UUID, defaultSpaceID : UUID, owner : Agent, spaceRepositoryProvider : javax.inject.Provider<SpaceRepository>, factories : javax.inject.Provider<Factories>, loggingService : LoggingService, listenerFactory : SpaceRepositoryListenerFactory)` Constructs a `Context`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSpaceRepositoryListener(listener : SpaceRepositoryListener)` Add listener on the space repository changes.
`<S extends Space> S`	`createSpace(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*)` Create an instance of space following the given specification.
`void`	`destroy()` Destroy any associated resources.
`protected SpaceRepository`	`ensureRepository([defaultSpaceCallback : (OpenEventSpace)=>void])` Replies the space repository and creates it if it does not exist.
`OpenEventSpace`	`getDefaultSpace()` Replies the default space of the context.
`UUID`	`getID()` Replies the identifier of the agent that has this trait.
`protected ReadWriteLock`	`getLock()` Replies the lock to be used.
`<S extends Space> S`	`getOrCreateSpaceWithID(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*)` Retrieve or create an instance of space with the given identifier.
`<S extends Space> S`	`getOrCreateSpaceWithSpec(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*)` Retrieve or create an instance of space which was created with the given specification.
`<S extends Space> S`	`getSpace(spaceUUID : UUID)` Retrieve, but do not create, an instance of space following the given ID.
`ConcurrentCollection<? extends Space>`	`getSpaces()` Replies all the spaces defined in this context.
`<S extends Space> ConcurrentCollection<S>`	`getSpaces(spec : Class<? extends SpaceSpecification<S>>)` Replies all the spaces that are implementing the given specification.
`void`	`initialize()` Initialize the context when it is published to the agents.
`boolean`	`isRootContext()` Replies if the context is a root context.
`void`	`removeSpaceRepositoryListener(listener : SpaceRepositoryListener)` Remove listener on the space repository changes.
`void`	`toString(builder : org.eclipse.xtext.xbase.lib.util.ToStringBuilder)` fill the given builder with the string representation of this object.

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

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

Methods inherited from interface io.sarl.lang.core.AgentContext
getOrCreateSpace, getOrCreateSpaceWithID

- Constructor Detail
  - Context
```
public new(id : UUID,
           defaultSpaceID : UUID,
           owner : Agent,
           spaceRepositoryProvider : javax.inject.Provider<SpaceRepository>,
           factories : javax.inject.Provider<Factories>,
           loggingService : LoggingService,
           listenerFactory : SpaceRepositoryListenerFactory)
```
    Constructs a Context.
    
    Parameters:
    
    id - identifier of the context.
    
    defaultSpaceID - identifier of the default space in the context.
    
    owner - is the owner of the context. If null, it is the root context.
    
    factories - the provider of factories.
    
    spaceRepositoryProvider - the provider of space repository
    
    logger - the logging service.
    
    listenerFactory - the factory of space listeners.
- Method Detail
  - getLock
```
@Pure
protected def getLock() : ReadWriteLock 
```
    Description copied from class: Context
    
    Replies the lock to be used.
  - isRootContext
```
@Pure
public def isRootContext() : boolean 
```
    Description copied from interface: AgentContext
    
    Replies if the context is a root context.
    A root context is associated to the platform kernel agent, which is not created into memory. For example, it means that there is no parent registered into the default space.
    
    Specified by:
    
    isRootContext in interface AgentContext
    
    Returns:
    
    true if the context is a root context.
  - getID
```
@Pure
public def getID() : UUID 
```
    Description copied from class: AgentTrait
    
    Replies the identifier of the agent that has this trait.
    
    Specified by:
    
    getID in interface AgentContext
    
    Overrides:
    
    getID in class AgentTrait
    
    Returns:
    
    the UUID of the owner.
  - 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.
  - ensureRepository
```
protected def ensureRepository([defaultSpaceCallback : (OpenEventSpace)=>void]) : SpaceRepository 
```
    Description copied from class: Context
    
    Replies the space repository and creates it if it does not exist.
    This function is thread-safe.
    
    Parameters:
    
    defaultSpaceCallback - the call back for default space.
    
    Returns:
    
    the space repository.
  - initialize
```
public def initialize() : void 
```
    Description copied from class: Context
    
    Initialize the context when it is published to the agents.
  - destroy
```
public def destroy() : void 
```
    Description copied from class: Context
    
    Destroy any associated resources.
  - getDefaultSpace
```
@Pure
public def getDefaultSpace() : OpenEventSpace 
```
    Description copied from interface: AgentContext
    
    Replies the default space of the context. The default space is assumed to be always an event-based space.
    
    Specified by:
    
    getDefaultSpace in interface AgentContext
    
    Returns:
    
    the default space.
  - getSpace
```
@Pure
public def getSpace(spaceUUID : UUID) : S  with <S extends Space> 
```
    Description copied from interface: AgentContext
    
    Retrieve, but do not create, an instance of space following the given ID. This function tries to find a space that fits the given specification. If none was found, this function replies null.
    
    Specified by:
    
    getSpace in interface AgentContext
    
    Type Parameters:
    
    S - - type of the replied space.
    
    Parameters:
    
    spaceUUID - identifier of the space.
    
    Returns:
    
    the space, or null if there is no space found.
    
    See Also:
    
    AgentContext.createSpace(Class, UUID, Object...), AgentContext.getOrCreateSpace(Class, UUID, Object...)
  - getSpaces
```
@Pure
public def getSpaces(spec : Class<? extends SpaceSpecification<S>>) : ConcurrentCollection<S>  with <S extends Space> 
```
    Description copied from interface: AgentContext
    
    Replies all the spaces that are implementing the given specification.
    
    Specified by:
    
    getSpaces in interface AgentContext
    
    Type Parameters:
    
    S - - type of the replied space.
    
    Parameters:
    
    spec - specification of the space to retreive.
    
    Returns:
    
    the spaces associated to the given space specification.
  - getSpaces
```
@Pure
public def getSpaces() : ConcurrentCollection<? extends Space> 
```
    Description copied from interface: AgentContext
    
    Replies all the spaces defined in this context.
    
    Specified by:
    
    getSpaces in interface AgentContext
    
    Returns:
    
    the spaces.
  - createSpace
```
public def createSpace(spec : Class<? extends SpaceSpecification<S>>,
                       spaceUUID : UUID,
                       creationParams : Object*) : S  with <S extends Space> 
```
    Description copied from interface: AgentContext
    
    Create an instance of space following the given specification. This function always creates a new instance of space. It means that is a space with the given identifier already exists, this function does nothing and replies null. If you want to find an existing space prior to the creation of a new one, you should use AgentContext.getOrCreateSpace(Class, UUID, Object...).
    
    Specified by:
    
    createSpace in interface AgentContext
    
    Type Parameters:
    
    S - - type of the created space.
    
    Parameters:
    
    spec - specification of the space to create.
    
    spaceUUID - identifier of the new space.
    
    creationParams - parameters to pass to the space constructor.
    
    Returns:
    
    the new space, or null if the space already exists.
    
    See Also:
    
    AgentContext.getOrCreateSpace(Class, UUID, Object...), AgentContext.getSpace(UUID)
  - getOrCreateSpaceWithSpec
```
public def getOrCreateSpaceWithSpec(spec : Class<? extends SpaceSpecification<S>>,
                                    spaceUUID : UUID,
                                    creationParams : Object*) : S  with <S extends Space> 
```
    Description copied from interface: AgentContext
    
    Retrieve or create an instance of space which was created with the given specification.
    This function tries to find a space that was created with the given specification. If none was found, this function creates a new space with the given space identifier and creation parameters.
    Caution: This function ignores the default space when searching for a space created with an EventSpaceSpecification or OpenEventSpaceSpecification. Consequently, in the case of the spec argument is one of the previous types, and there is no other space in the context that was created with this specification, then the function creates a totally new space.
    Caution: The spaceUUID parameter is used only if no existing space created with the given specification was found.
    
    Specified by:
    
    getOrCreateSpaceWithSpec in interface AgentContext
    
    Type Parameters:
    
    S - - type of the replied space.
    
    Parameters:
    
    spec - specification of the space to retrieve/create.
    
    spaceUUID - identifier used only when creating the space.
    
    creationParams - parameters to pass to the space constructor.
    
    Returns:
    
    the space, never null and never the default space.
    
    See Also:
    
    AgentContext.getOrCreateSpaceWithID(UUID, Class, Object...), AgentContext.createSpace(Class, UUID, Object...), AgentContext.getSpace(UUID)
  - getOrCreateSpaceWithID
```
public def getOrCreateSpaceWithID(spec : Class<? extends SpaceSpecification<S>>,
                                  spaceUUID : UUID,
                                  creationParams : Object*) : S  with <S extends Space> 
```
    Description copied from interface: AgentContext
    
    Retrieve or create an instance of space with the given identifier.
    This function tries to find a space with the given identifier. If none was found, this function creates a new space with the given specification and creation parameters.
    Caution #1: The spaceUUID parameter is given to the specification when creating the space.
    Caution #2: The spaceUUID parameter is equal to the identifier of the default space in this context, then the default space is returned by this function.
    
    Specified by:
    
    getOrCreateSpaceWithID in interface AgentContext
    
    Type Parameters:
    
    S - - type of the replied space.
    
    Parameters:
    
    spec - specification of the space for creating the space.
    
    spaceUUID - identifier of the space.
    
    creationParams - parameters to pass to the space constructor.
    
    Returns:
    
    the space, never null.
    
    See Also:
    
    AgentContext.getOrCreateSpaceWithID(UUID, Class, Object...), AgentContext.createSpace(Class, UUID, Object...), AgentContext.getSpace(UUID)
  - addSpaceRepositoryListener
```
public def addSpaceRepositoryListener(listener : SpaceRepositoryListener) : void 
```
    Description copied from class: Context
    
    Add listener on the space repository changes.
    
    Parameters:
    
    listener -
  - removeSpaceRepositoryListener
```
public def removeSpaceRepositoryListener(listener : SpaceRepositoryListener) : void 
```
    Description copied from class: Context
    
    Remove listener on the space repository changes.
    
    Parameters:
    
    listener -

Class Context

Constructor Summary

Method Summary

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

Methods inherited from interface io.sarl.lang.core.AgentContext

Constructor Detail

Context

Method Detail

getLock

isRootContext

getID

toString

ensureRepository

initialize

destroy

getDefaultSpace

getSpace

getSpaces

getSpaces

createSpace

getOrCreateSpaceWithSpec

getOrCreateSpaceWithID

addSpaceRepositoryListener

removeSpaceRepositoryListener