io.sarl.api.naming.name.SpaceName.sarl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api.naming Show documentation

Naming Library of the SARL SDK

The newest version!

/* 
 * $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.api.naming.name

import io.sarl.lang.core.annotation.PrivateAPI
import java.net.URI
import java.util.UUID
import org.eclipse.xtend.lib.annotations.Accessors

/** 
 * This class represents a space name.
 *
 * The different components of a space name are: 

 * {@code contextId} (mandatory) : the identifier of the context in which the space is located.
 * {@code spaceId} (mandatory) : the identifier of the space.
 * 
 *
 * @author Stéphane Galland
 * @version api.naming 0.14.0 20241106-161408
 * @mavengroupid io.sarl.sdk
 * @mavenartifactid api.naming
 * @since 0.12
 */
class SpaceName extends SarlName {

	/** Scheme for spaces. */
	public static val SCHEME = "space"

	@Accessors
	val contextId : UUID

	@Accessors
	val spaceId : UUID

	/** Constructor.
	 *
	 * @param uri the uri of the context.
	 * @param contextId the identifier of the context.
	 * @param spaceId the identifier of the context.
	 */
	@PrivateAPI
	new (uri : URI, contextId : UUID, spaceId : UUID) {
		super(uri)
		this.contextId = contextId
		this.spaceId = spaceId
	}

}