io.sarl.lang.core

Interface AgentContext

All Known Implementing Classes:

Context

public interface AgentContext

An AgentContext defines the boundary of a sub-system, and gathers a collection of Spaces. Each context has a default context that provides a basic interaction context.

Version:

0.8.0 2018-09-23 23:08:17

Author:

Sebastian Rodriguez

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Method Summary

Modifier and Type	Method and Description
<S extends Space> S	createSpace(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*) Create an instance of space following the given specification.
EventSpace	getDefaultSpace() Replies the default space of the context.
UUID	getID() Replies the identifier of the context.
default <S extends Space> S	getOrCreateSpace(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*) Deprecated. see AgentContext.getOrCreateSpaceWithSpec(Class, UUID, Object...)
<S extends Space> S	getOrCreateSpaceWithID(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*) Retreive or create an instance of space with the given identifier.
default <S extends Space> S	getOrCreateSpaceWithID(spaceUUID : UUID, spec : Class<? extends SpaceSpecification<S>>, creationParams : Object*) Deprecated. see AgentContext.getOrCreateSpaceWithID(Class, UUID, Object...)
<S extends Space> S	getOrCreateSpaceWithSpec(spec : Class<? extends SpaceSpecification<S>>, spaceUUID : UUID, creationParams : Object*) Retreive or create an instance of space which was created with the given specification.
<S extends Space> S	getSpace(spaceUUID : UUID) Retreive, but do not create, an instance of space following the given ID.
SynchronizedIterable<? extends Space>	getSpaces() Replies all the spaces defined in this context.
<S extends Space> SynchronizedIterable<S>	getSpaces(spec : Class<? extends SpaceSpecification<S>>) Replies all the spaces that are implementing the given specification.

Method Detail

getID

@Pure
def getID() : UUID 

Description copied from interface: AgentContext

Replies the identifier of the context.

Returns:

the identifier of the context.

getDefaultSpace

@Pure
def getDefaultSpace() : EventSpace 

Description copied from interface: AgentContext

Replies the default space of the context. The default space is assumed to be always an event-based space.

Returns:

the default space.

getSpaces

@Pure
def getSpaces() : SynchronizedIterable<? extends Space> 

Description copied from interface: AgentContext

Replies all the spaces defined in this context.

Returns:

the spaces.

getSpaces

@Pure
def getSpaces(spec : Class<? extends SpaceSpecification<S>>) : SynchronizedIterable<S>  with <S extends Space> 

Description copied from interface: AgentContext

Replies all the spaces that are implementing the given specification.

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.

createSpace

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...).

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)

getOrCreateSpace

@Deprecated
default def getOrCreateSpace(spec : Class<? extends SpaceSpecification<S>>,
                                         spaceUUID : UUID,
                                         creationParams : Object*) : S  with <S extends Space> 

Deprecated. see AgentContext.getOrCreateSpaceWithSpec(Class, UUID, Object...)

Description copied from interface: AgentContext

Retreive 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: The spaceUUID parameter is used only if no existing space created with the given specification was found.

Type Parameters:

S - - type of the replied space.

Parameters:

spec - specification of the space to retreive/create.

spaceUUID - identifier used only when creating 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)

getOrCreateSpaceWithSpec

def getOrCreateSpaceWithSpec(spec : Class<? extends SpaceSpecification<S>>,
                             spaceUUID : UUID,
                             creationParams : Object*) : S  with <S extends Space> 

Description copied from interface: AgentContext

Retreive 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: The spaceUUID parameter is used only if no existing space created with the given specification was found.

Type Parameters:

S - - type of the replied space.

Parameters:

spec - specification of the space to retreive/create.

spaceUUID - identifier used only when creating 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)

getOrCreateSpaceWithID

@Deprecated
default def getOrCreateSpaceWithID(spaceUUID : UUID,
                                               spec : Class<? extends SpaceSpecification<S>>,
                                               creationParams : Object*) : S  with <S extends Space> 

Deprecated. see AgentContext.getOrCreateSpaceWithID(Class, UUID, Object...)

Description copied from interface: AgentContext

Retreive 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: The spaceUUID parameter is given to the specification when creating the space.

Type Parameters:

S - - type of the replied space.

Parameters:

spaceUUID - identifier of the space.

spec - specification of the space for creating 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)

getOrCreateSpaceWithID

def getOrCreateSpaceWithID(spec : Class<? extends SpaceSpecification<S>>,
                           spaceUUID : UUID,
                           creationParams : Object*) : S  with <S extends Space> 

Description copied from interface: AgentContext

Retreive 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: The spaceUUID parameter is given to the specification when creating the space.

Type Parameters:

S - - type of the replied space.

Parameters:

spaceUUID - identifier of the space.

spec - specification of the space for creating the space.

creationParams - parameters to pass to the space constructor.

Returns:

the space, never null.

Since:

0.6

See Also:

AgentContext.getOrCreateSpaceWithID(UUID, Class, Object...), AgentContext.createSpace(Class, UUID, Object...), AgentContext.getSpace(UUID)

getSpace

@Pure
def getSpace(spaceUUID : UUID) : S  with <S extends Space> 

Description copied from interface: AgentContext

Retreive, 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.

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...)