SpaceRepository (SARL Agent Oriented Programming Language 0.12.0 API)

All Implemented Interfaces:

SpaceListener, EventListener
```
public abstract class SpaceRepository
extends Object
implements SpaceListener
```
A repository of spaces specific to a given context.
This repository is thread-safe.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Nicolas Gaud, Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpaceRepository.SpaceDescription` Description of a space.
`static class`	`SpaceRepository.SpaceSpecificationKey` Key for a space specification.

Field Summary

Fields
Modifier and Type Field and Description

protected Logger logger

Fields
Modifier and Type	Field and Description
`protected Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description
`SpaceRepository(injector : com.google.inject.Injector, executor : ExecutorService, logger : LoggingService, config : SreConfig, specificationFactory : SreSpaceSpecificationFactory, factories : javax.inject.Provider<Factories>)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSpaceRepositoryListener(listener : SpaceRepositoryListener)` Add listener on the space repository changes.
`OpenEventSpace`	`createDefaultSpace(spaceID : SpaceID)` Create an instance of the default space if it was not created before.
`protected Logger`	`createLogger(loggingService : LoggingService)` Create the logger for this repository.
`<S extends Space> S`	`createSpace(spaceID : SpaceID, spec : Class<? extends SpaceSpecification<S>>, creationParams : Object*)` Create a space.
`protected SpaceRepository.SpaceDescription`	`createSpaceDescription(id : SpaceID, space : Space)` Create a space description.
`protected <S extends Space> S`	`createSpaceFirstInstance(spec : Class<? extends SpaceSpecification<S>>, spaceID : SpaceID, creationParams : Object[])` Create the first instance of a given space.
`void`	`destroy()` Destroy this repository and release all the resources.
`void`	`destroyableSpace(space : Space)` Invoked when the space could be destroyed.
`protected void`	`destroyThreadUnsafe()` Destroy this repository and release all the resources inside a synchronized section.
`protected void`	`fireSpaceAdded(space : Space, isLocalCreation : boolean)` Notifies the listeners on the space creation.
`protected void`	`fireSpaceRemoved(space : Space, isLocalDestruction : boolean)` Notifies the listeners on the space destruction.
`protected ReadWriteLock`	`getLock()`
`<S extends Space> S`	`getOrCreateSpaceWithID(spaceID : SpaceID, spec : Class<? extends SpaceSpecification<S>>, creationParams : Object*)` Retrieve the first space of the given identifier, or create a space if none.
`<S extends Space> S`	`getOrCreateSpaceWithSpec(spaceID : SpaceID, spec : Class<? extends SpaceSpecification<S>>, creationParams : Object*)` Retrieve the first space of the given specification, or create a space if none.
`protected abstract Map<UUID,SpaceRepository.SpaceDescription>`	`getSharedStructure()` Replies the internal map that contains the spaces.
`Space`	`getSpace(spaceID : SpaceID)` Returns the first instance of a space with the specified SpaceID.
`ConcurrentCollection<? extends Space>`	`getSpaces()` Returns the collection of all spaces stored in this repository.
`<S extends Space> ConcurrentCollection<S>`	`getSpaces(spec : Class<? extends SpaceSpecification<S>>)` Returns the collection of all spaces with the specified `SpaceSpecification` stored in this repository.
`boolean`	`hasSpace(id : UUID)` Replies if the given space was defined into the repository.
`protected SpaceRepository.SpaceDescription`	`life(spaceId : SpaceID, newDescription : SpaceRepository.SpaceDescription)` Replies the space information associated to the space identifier if already associated.
`protected SpaceRepository.SpaceDescription`	`life(space : Space, newDescription : SpaceRepository.SpaceDescription)` Replies the space information associated to the space if already associated.
`void`	`refreshInternalStructures()` Synchronize the internal structures of SpaceRepository with the content of `SpaceRepository.getSharedStructure()`.
`protected void`	`removeEmptySpaces()` Remove all the spaces that are empty.
`void`	`removeSpace(space : Space)` Remove the given space.
`void`	`removeSpaceIfEmpty(space : Space)` Remove the given space if the it is empty, i.e. it has no more strong participant.
`void`	`removeSpaceIfEmpty(id : UUID)` Remove the space with the given id if the space is empty, i.e. it has no more strong participant.
`void`	`removeSpaceRepositoryListener(listener : SpaceRepositoryListener)` Remove listener on the space repository changes.

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

- Field Detail
  - logger
```
protected val logger : Logger
```
- Constructor Detail
  - SpaceRepository
```
@Inject
public new(injector : com.google.inject.Injector,
                   executor : ExecutorService,
                   logger : LoggingService,
                   config : SreConfig,
                   specificationFactory : SreSpaceSpecificationFactory,
                   factories : javax.inject.Provider<Factories>)
```
    Constructor.
    
    Parameters:
    
    injector - the injector.
    
    executor - the asynchronous execution service.
    
    logger - the logging service.
    
    config - the configuration.
    
    specificiationFactory - the factory of space spacification.
    
    factories - the provider of factories tool.
- Method Detail
  - createLogger
```
@Pure
protected def createLogger(loggingService : LoggingService) : Logger 
```
    Description copied from class: SpaceRepository
    
    Create the logger for this repository.
    This function should not have a border effect; and it is therefore thread-safe.
    
    Parameters:
    
    loggingService - the service for logging.
    
    Returns:
    
    the logger.
  - getSharedStructure
```
@Pure
protected abstract def getSharedStructure() : Map<UUID,SpaceRepository.SpaceDescription> 
```
    Description copied from class: SpaceRepository
    
    Replies the internal map that contains the spaces.
    This function should not have a border effect; and it is therefore thread-safe.
    This function shoud be invoked into a locked/synchronized block of code. That's why it does not need to reply a "concurrent" collection. Moreover, all the functions that are providing a collection of spaces to the outside of this class are creating a copy of the collection that is "concurrent".
    
    Returns:
    
    the internal data structure for storing the spaces.
  - createSpaceDescription
```
@Pure
protected def createSpaceDescription(id : SpaceID,
                                           space : Space) : SpaceRepository.SpaceDescription 
```
    Description copied from class: SpaceRepository
    
    Create a space description.
    This function should be overridden by the sub-types.
    This function should not have a border effect; and it is therefore thread-safe.
    
    Parameters:
    
    id - the space identifier.
    
    space - the space instance.
    
    Returns:
    
    the description.
  - life
```
protected def life(space : Space,
                   newDescription : SpaceRepository.SpaceDescription) : SpaceRepository.SpaceDescription 
```
    Description copied from class: SpaceRepository
    
    Replies the space information associated to the space if already associated.
    This function is not thread-safe; but enough efficient to be assumed to not cause issues related to threads.
    
    Parameters:
    
    newDescription - the description to associated to the space.
    
    Returns:
    
    the space description, or null
  - life
```
protected def life(spaceId : SpaceID,
                   newDescription : SpaceRepository.SpaceDescription) : SpaceRepository.SpaceDescription 
```
    Description copied from class: SpaceRepository
    
    Replies the space information associated to the space identifier if already associated.
    This function is not thread-safe; but enough efficient to be assumed to not cause issues related to threads.
    
    Parameters:
    
    newDescription - the description to associated to the space.
    
    Returns:
    
    the space description, or null
  - createDefaultSpace
```
public def createDefaultSpace(spaceID : SpaceID) : OpenEventSpace 
```
    Description copied from class: SpaceRepository
    
    Create an instance of the default space if it was not created before.
    This function is thread-safe.
    
    Parameters:
    
    spaceID - ID of the default space.
    
    Returns:
    
    the new space.
  - createSpaceFirstInstance
```
protected def createSpaceFirstInstance(spec : Class<? extends SpaceSpecification<S>>,
                                       spaceID : SpaceID,
                                       creationParams : Object[]) : S  with <S extends Space> 
```
    Description copied from class: SpaceRepository
    
    Create the first instance of a given space.
    This function is thread-safe. It notifies the listeners about the space creation.
    
    Parameters:
    
    spec - is the type of space specification to be used for creating the space.
    
    spaceID - is the identifier to give to the new space instance.
    
    creationParams - is the list of parameters that must be used for creating the space instance, through the space specification.
  - refreshInternalStructures
```
public def refreshInternalStructures() : void 
```
    Description copied from class: SpaceRepository
    
    Synchronize the internal structures of SpaceRepository with the content of SpaceRepository.getSharedStructure().
    This function is thread-safe.
    Caution: Do not call this function if you are not certain it does the expected things.
  - destroy
```
public final def destroy() : void 
```
    Description copied from class: SpaceRepository
    
    Destroy this repository and release all the resources.
  - destroyThreadUnsafe
```
protected def destroyThreadUnsafe() : void 
```
    Description copied from class: SpaceRepository
    
    Destroy this repository and release all the resources inside a synchronized section.
    This function is not thread-safe.
  - createSpace
```
public def createSpace(spaceID : SpaceID,
                       spec : Class<? extends SpaceSpecification<S>>,
                       creationParams : Object*) : S  with <S extends Space> 
```
    Description copied from class: SpaceRepository
    
    Create a space. This function does not test if the space already exist into the repository. It means that any previously created instance of a space with the given space identifier will be lost after the return of this function.
    This function notifies the listeners about the space creation.
    
    Type Parameters:
    
    S - - the type of the space to reply.
    
    Parameters:
    
    spaceID - ID of the space.
    
    spec - specification of the space.
    
    creationParams - creation parameters.
    
    Returns:
    
    the new space, or null if the space already exists.
  - removeEmptySpaces
```
protected def removeEmptySpaces() : void 
```
    Description copied from class: SpaceRepository
    
    Remove all the spaces that are empty.
    This function is thread-safe.
    
    Since:
    
    0.12
  - removeSpaceIfEmpty
```
public def removeSpaceIfEmpty(id : UUID) : void 
```
    Description copied from class: SpaceRepository
    
    Remove the space with the given id if the space is empty, i.e. it has no more strong participant.
    This function is thread-safe.
    
    Parameters:
    
    id - is the identifier of the space.
    
    Since:
    
    0.12
  - removeSpaceIfEmpty
```
public def removeSpaceIfEmpty(space : Space) : void 
```
    Description copied from class: SpaceRepository
    
    Remove the given space if the it is empty, i.e. it has no more strong participant.
    This function is thread-safe.
    
    Parameters:
    
    id - is the identifier of the space.
    
    Since:
    
    0.12
  - removeSpace
```
public def removeSpace(space : Space) : void 
```
    Description copied from class: SpaceRepository
    
    Remove the given space.
    This function notifies the listeners about the space removal.
    
    Parameters:
    
    space - the space.
  - getOrCreateSpaceWithSpec
```
@Pure
public def getOrCreateSpaceWithSpec(spaceID : SpaceID,
                                          spec : Class<? extends SpaceSpecification<S>>,
                                          creationParams : Object*) : S  with <S extends Space> 
```
    Description copied from class: SpaceRepository
    
    Retrieve the first space of the given specification, or create a space if none.
    
    Type Parameters:
    
    S - - the type of the space to reply.
    
    Parameters:
    
    spaceID - ID of the space (used only when creating a space).
    
    spec - specification of the space.
    
    creationParams - creation parameters (used only when creating a space).
    
    Returns:
    
    the new space.
  - getOrCreateSpaceWithID
```
@Pure
public def getOrCreateSpaceWithID(spaceID : SpaceID,
                                        spec : Class<? extends SpaceSpecification<S>>,
                                        creationParams : Object*) : S  with <S extends Space> 
```
    Description copied from class: SpaceRepository
    
    Retrieve the first space of the given identifier, or create a space if none.
    
    Type Parameters:
    
    S - - the type of the space to reply.
    
    Parameters:
    
    spaceID - ID of the space.
    
    spec - specification of the space.
    
    creationParams - creation parameters (used only when creating a space).
    
    Returns:
    
    the new space.
  - getSpaces
```
@Pure
public def getSpaces() : ConcurrentCollection<? extends Space> 
```
    Description copied from class: SpaceRepository
    
    Returns the collection of all spaces stored in this repository.
    
    Returns:
    
    the collection of all spaces stored in this repository.
  - getSpaces
```
@Pure
public def getSpaces(spec : Class<? extends SpaceSpecification<S>>) : ConcurrentCollection<S>  with <S extends Space> 
```
    Description copied from class: SpaceRepository
    
    Returns the collection of all spaces with the specified SpaceSpecification stored in this repository.
    
    Type Parameters:
    
    S - - type of the spaces to reply.
    
    Parameters:
    
    spec - the specification used to filter the set of stored spaces.
    
    Returns:
    
    the collection of all spaces with the specified SpaceSpecification stored in this repository
  - getSpace
```
@Pure
public def getSpace(spaceID : SpaceID) : Space 
```
    Description copied from class: SpaceRepository
    
    Returns the first instance of a space with the specified SpaceID.
    
    Parameters:
    
    spaceID - the identifier to retrieve.
    
    Returns:
    
    the space instance of null if none.
  - addSpaceRepositoryListener
```
public def addSpaceRepositoryListener(listener : SpaceRepositoryListener) : void 
```
    Description copied from class: SpaceRepository
    
    Add listener on the space repository changes.
    This function is thread-safe.
    
    Parameters:
    
    listener -
  - removeSpaceRepositoryListener
```
public def removeSpaceRepositoryListener(listener : SpaceRepositoryListener) : void 
```
    Description copied from class: SpaceRepository
    
    Remove listener on the space repository changes.
    This function is thread-safe.
    
    Parameters:
    
    listener -
  - fireSpaceAdded
```
protected def fireSpaceAdded(space : Space,
                             isLocalCreation : boolean) : void 
```
    Description copied from class: SpaceRepository
    
    Notifies the listeners on the space creation.
    This function is thread-safe.
    
    Parameters:
    
    space - the created space.
    
    isLocalCreation - indicates if the creation of the space was initiated on the current kernel.
  - fireSpaceRemoved
```
protected def fireSpaceRemoved(space : Space,
                               isLocalDestruction : boolean) : void 
```
    Description copied from class: SpaceRepository
    
    Notifies the listeners on the space destruction.
    This function is thread-safe.
    
    Parameters:
    
    space - the removed space.
    
    isLocalDestruction - indicates if the destruction of the space was initiated on the current kernel.
  - destroyableSpace
```
public def destroyableSpace(space : Space) : void 
```
    Description copied from interface: SpaceListener
    
    Invoked when the space could be destroyed.
    
    Specified by:
    
    destroyableSpace in interface SpaceListener
    
    Parameters:
    
    space - reference to the created space.
  - hasSpace
```
@Pure
public def hasSpace(id : UUID) : boolean 
```
    Description copied from class: SpaceRepository
    
    Replies if the given space was defined into the repository.
    
    Parameters:
    
    id - is the identifier of the space.
    
    Returns:
    
    true if the space exists into the repository, or false otherwise.
  - getLock
```
@Pure
protected def getLock() : ReadWriteLock 
```

Class SpaceRepository

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

SpaceRepository

Method Detail

createLogger

getSharedStructure

createSpaceDescription

life

life

createDefaultSpace

createSpaceFirstInstance

refreshInternalStructures

destroy

destroyThreadUnsafe

createSpace

removeEmptySpaces

removeSpaceIfEmpty

removeSpaceIfEmpty

removeSpace

getOrCreateSpaceWithSpec

getOrCreateSpaceWithID

getSpaces

getSpaces

getSpace

addSpaceRepositoryListener

removeSpaceRepositoryListener

fireSpaceAdded

fireSpaceRemoved

destroyableSpace

hasSpace

getLock