io.sarl.api.core.spaces
Class AbstractSpaceSpecification<S>
Type Parameters:
S - type of the spaces that may be created by this specification.
All Superinterfaces:
SpaceSpecification<S>
All Known Subclasses:
AbstractSreEventSpaceSpecification<S>
@org.eclipse.xtext.xbase.lib.XbaseGenerated
abstract class AbstractSpaceSpecification<S>
extends java.lang.Object
implements SpaceSpecification<S>
Abstract implementation of a space specification that could provide a space component factory and a participant listener factory. These two factories usually depends on the SRE implementation.
Parameters:
<S> - type of the spaces that may be created by this specification.
Maven Group Identifier:
io.sarl.sdk
Maven Artifact Identifier:
api.core
Since:
0.15
Property Summary
Modifier and type Property and description
OpenEventSpace defaultSpace
Replies the reference to the default space of the context in which the created spaces will be created.
java.util.function.Function<T,R> loggerProvider
Replies the provider of logger for the create spaces.
SpaceComponentFactory spaceComponentFactory
Replies the factory of the space components that are specific to the SRE implementation.
SpaceParticipantListenerFactory spaceParticipantListenerFactory
Replies the factory for building listeners on changes in the participants' list.
Constructor Summary
Constructor and description
new(Provider<T>,Provider<T>)
Constructor.
Action Summary
Modifier and type Action and description
OpenEventSpace getDefaultSpace
Replies the reference to the default space of the context in which the created spaces will be created.
java.util.function.Function<T,R> getLoggerProvider
Replies the provider of logger for the create spaces.
SpaceComponentFactory getSpaceComponentFactory
Replies the factory of the space components that are specific to the SRE implementation.
SpaceParticipantListenerFactory getSpaceParticipantListenerFactory
Replies the factory for building listeners on changes in the participants' list.
void setDefaultSpace(OpenEventSpace)
void setDefaultSpaceProvider(Provider<T>)
Change the provider of a default space.
void setLoggerProvider(Function<T,R>)
void setSpaceComponentFactory(SpaceComponentFactory)
void setSpaceComponentFactoryProvider(Provider<T>)
Change the provider of a factory on space component.
void setSpaceParticipantListenerFactory(SpaceParticipantListenerFactory)
void setSpaceParticipantListenerFactoryProvider(Provider<T>)
Change the provider of a factory on space participant listener.
Inherited: create(SpaceID,Object*)
Property Details
defaultSpace
var defaultSpace : OpenEventSpace
Replies the reference to the default space of the context in which the created spaces will be created.

This property is an alias for the action: getDefaultSpace

Returns:
the default space.
loggerProvider
var loggerProvider : java.util.function.Function<T,R>
Replies the provider of logger for the create spaces.

This property is an alias for the action: getLoggerProvider

Returns:
the provider that maps a space identifier to its logger. If there is no logger provider specified, an anonymous logger is provided.
spaceComponentFactory
var spaceComponentFactory : SpaceComponentFactory
Replies the factory of the space components that are specific to the SRE implementation.

This property is an alias for the action: getSpaceComponentFactory

Returns:
the factory.
spaceParticipantListenerFactory
var spaceParticipantListenerFactory : SpaceParticipantListenerFactory
Replies the factory for building listeners on changes in the participants' list.

This property is an alias for the action: getSpaceParticipantListenerFactory

Returns:
the factory.
Constructor Details
new(Provider<T>,Provider<T>)
new(Provider<T>,Provider<T>)
Constructor.
Parameters:
spaceComponentFactoryProvider - the provider of space component factory. It may be null.
spaceParticipantListenerFactoryProvider - the provider of listener on space participant changes. It may be null.
Action Details
getDefaultSpace
def getDefaultSpace : OpenEventSpace
Replies the reference to the default space of the context in which the created spaces will be created.
Returns:
the default space.
getLoggerProvider
def getLoggerProvider : java.util.function.Function<T,R>
Replies the provider of logger for the create spaces.
Returns:
the provider that maps a space identifier to its logger. If there is no logger provider specified, an anonymous logger is provided.
getSpaceComponentFactory
def getSpaceComponentFactory : SpaceComponentFactory
Replies the factory of the space components that are specific to the SRE implementation.
Returns:
the factory.
getSpaceParticipantListenerFactory
def getSpaceParticipantListenerFactory : SpaceParticipantListenerFactory
Replies the factory for building listeners on changes in the participants' list.
Returns:
the factory.
setDefaultSpace(OpenEventSpace)
def setDefaultSpace(OpenEventSpace)
setDefaultSpaceProvider(Provider<T>)
def setDefaultSpaceProvider(Provider<T>)
Change the provider of a default space.
Parameters:
provider - the new provider.
setLoggerProvider(Function<T,R>)
def setLoggerProvider(Function<T,R>)
setSpaceComponentFactory(SpaceComponentFactory)
def setSpaceComponentFactory(SpaceComponentFactory)
setSpaceComponentFactoryProvider(Provider<T>)
def setSpaceComponentFactoryProvider(Provider<T>)
Change the provider of a factory on space component.
Parameters:
provider - the new provider.
setSpaceParticipantListenerFactory(SpaceParticipantListenerFactory)
def setSpaceParticipantListenerFactory(SpaceParticipantListenerFactory)
setSpaceParticipantListenerFactoryProvider(Provider<T>)
def setSpaceParticipantListenerFactoryProvider(Provider<T>)
Change the provider of a factory on space participant listener.
Parameters:
provider - the new provider.