All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.sarl.api.naming.name.SarlName.sarl Maven / Gradle / Ivy

    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 java.io.Serializable
import java.lang.ref.WeakReference
import java.net.URI

/** 
 * This class represents a component name. Each component in a name is an atomic name.
 * 
 * 
    The components of a name are numbered. The indexes of a
 * name with N components range from 0 up to, but not including, N.
 * An empty compound name has no components.
 * 
 * 
    Multithreaded Access
    
 * A {@code SName} instance is not synchronized against concurrent
 * multithreaded access. Multiple threads trying to access and modify a
 * {@code SName} should lock the object.
 * 
 * @author Stéphane Galland
 * @version api.naming 0.14.0 20241106-161408
 * @mavengroupid io.sarl.sdk
 * @mavenartifactid api.naming
 * @since 0.12
 */
abstract class SarlName implements Cloneable, Serializable, Comparable {

	transient var associatedObject : WeakReference

	val uri : URI

	protected new (uri : URI) {
		assert uri !== null
		this.uri = uri
	}

	override toString : String {
		this.uri.toString
	}

	/** Replies the scheme of this name.
	 */
	def getScheme : String {
		return this.uri.scheme.toLowerCase
	}

	@Pure
	override compareTo(name : SarlName) : int {
		if (name === null) 1 else this.uri.compareTo(name.uri)
	}

	/** Replies the URI associated to this name. */
	def toURI : URI {
		this.uri
	}

	/** Replies the name of the fragment. */
	def getFragment : String {
		this.uri.fragment
	}

	/** Replies if this name has a fragment associated to it.
	 */
	def hasFragment : boolean {
		!this.uri.fragment.isNullOrEmpty
	}
	
	/** Replies the associated object.
	 */
	final def getAssociatedObject : Object {
		this.associatedObject?.get
	}

	/** Change the associated object.
	 */
	final def setAssociatedObject(obj : Object) {
		this.associatedObject = if (obj === null) null else new WeakReference(obj)
	}

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy