io.sarl.lang.core.AgentContext Maven / Gradle / Ivy
Show all versions of core Show documentation
/*
* $Id$
*
* SARL is an general-purpose agent programming language.
* More details on http://www.sarl.io
*
* Copyright (C) 2014-2024 SARL.io, the Original Authors and Main Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.sarl.lang.core;
import java.util.UUID;
import org.eclipse.xtext.xbase.lib.Pure;
import io.sarl.lang.core.util.ConcurrentCollection;
/**
* 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.
*
* @author Sebastian Rodriguez
* @version core 0.14.0 20241106-161406
* @mavengroupid io.sarl.lang
* @mavenartifactid core
*/
public interface AgentContext {
/**
* Replies the identifier of the context.
*
* @return the identifier of the context.
*/
@Pure
UUID getID();
/**
* Replies the default space of the context. The default space is assumed to be
* always an {@link EventSpace event-based space}.
*
* @return the default space.
*/
@Pure
EventSpace getDefaultSpace();
/**
* Replies all the spaces defined in this context.
*
* @return the spaces.
*/
@Pure
ConcurrentCollection getSpaces();
/**
* Replies all the spaces that are implementing the given specification.
*
* @param - type of the replied space.
* @param spec specification of the space to retreive.
* @return the spaces associated to the given space specification.
*/
@Pure
ConcurrentCollection getSpaces(Class> spec);
/**
* 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
* {@code null}. If you want to find an existing space prior to the creation of
* a new one, you should use {@link #getOrCreateSpace(Class, UUID, Object...)}.
*
* @param - type of the created space.
* @param spec specification of the space to create.
* @param spaceUUID identifier of the new space.
* @param creationParams parameters to pass to the space constructor.
* @return the new space, or {@code null} if the space already exists.
* @see #getOrCreateSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
*/
S createSpace(Class> spec, UUID spaceUUID,
Object... creationParams);
/**
* 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 #1: This function ignores the default space when
* searching for a space created with an {@code EventSpaceSpecification} or
* {@code OpenEventSpaceSpecification}. Consequently, in the case of the
* {@code 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 #2: The {@code spaceUUID} parameter is used only if
* no existing space created with the given specification was found.
*
* @param - type of the replied space.
* @param spec specification of the space to retreive/create.
* @param spaceUUID identifier used only when creating the space.
* @param creationParams parameters to pass to the space constructor.
* @return the space, never {@code null} and never the default space.
* @see #getOrCreateSpaceWithID(UUID, Class, Object...)
* @see #createSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
* @deprecated see {@link #getOrCreateSpaceWithSpec(Class, UUID, Object...)}
*/
@Deprecated(since = "0.10", forRemoval = true)
default S getOrCreateSpace(Class> spec, UUID spaceUUID,
Object... creationParams) {
return getOrCreateSpaceWithSpec(spec, spaceUUID, creationParams);
}
/**
* 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 {@code EventSpaceSpecification} or
* {@code OpenEventSpaceSpecification}. Consequently, in the case of the
* {@code 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 {@code spaceUUID} parameter is used only if no
* existing space created with the given specification was found.
*
* @param - type of the replied space.
* @param spec specification of the space to retrieve/create.
* @param spaceUUID identifier used only when creating the space.
* @param creationParams parameters to pass to the space constructor.
* @return the space, never {@code null} and never the default space.
* @see #getOrCreateSpaceWithID(UUID, Class, Object...)
* @see #createSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
*/
S getOrCreateSpaceWithSpec(Class> spec, UUID spaceUUID,
Object... creationParams);
/**
* 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 {@code spaceUUID} parameter is given to the
* specification when creating the space.
*
*
Caution #2: The {@code spaceUUID} parameter is equal to the
* identifier of the default space in this context, then the default space is
* returned by this function.
*
* @param - type of the replied space.
* @param spaceUUID identifier of the space.
* @param spec specification of the space for creating the space.
* @param creationParams parameters to pass to the space constructor.
* @return the space, never {@code null}.
* @see #getOrCreateSpaceWithID(UUID, Class, Object...)
* @see #createSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
* @deprecated see {@link #getOrCreateSpaceWithID(Class, UUID, Object...)}
*/
@Deprecated(since = "0.10", forRemoval = true)
default S getOrCreateSpaceWithID(UUID spaceUUID, Class> spec,
Object... creationParams) {
return getOrCreateSpaceWithID(spec, spaceUUID, creationParams);
}
/**
* 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 {@code spaceUUID} parameter is given to the
* specification when creating the space.
*
*
Caution #2: The {@code spaceUUID} parameter is equal to the
* identifier of the default space in this context, then the default space is
* returned by this function.
*
* @param - type of the replied space.
* @param spaceUUID identifier of the space.
* @param spec specification of the space for creating the space.
* @param creationParams parameters to pass to the space constructor.
* @return the space, never {@code null}.
* @see #getOrCreateSpaceWithID(UUID, Class, Object...)
* @see #createSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
* @since 0.6
*/
S getOrCreateSpaceWithID(Class> spec, UUID spaceUUID,
Object... creationParams);
/**
* 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 {@code null}.
*
* @param - type of the replied space.
* @param spaceUUID identifier of the space.
* @return the space, or {@code null} if there is no space found.
* @see #createSpace(Class, UUID, Object...)
* @see #getOrCreateSpace(Class, UUID, Object...)
*/
@Pure
S getSpace(UUID spaceUUID);
/**
* 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.
*
* @return {@code true} if the context is a root context.
* @since 0.12
*/
@Pure
boolean isRootContext();
}