io.sarl.api.naming.name
Class SarlName
All Superinterfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<T>
All Known Subclasses:
AgentName, ArtifactName, BehaviorName, ContextName, ScopedDataName, ServiceName, SkillName, SpaceName
@org.eclipse.xtext.xbase.lib.XbaseGenerated
abstract class SarlName
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, java.lang.Comparable<T>
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 SName instance is not synchronized against concurrent multithreaded access. Multiple threads trying to access and modify a SName should lock the object.
Maven Group Identifier:
io.sarl.sdk
Maven Artifact Identifier:
api.naming
Since:
0.12
Property Summary
Modifier and type Property and description
java.lang.Object associatedObject
Replies the associated object.
java.lang.String fragment
Replies the name of the fragment.
java.lang.String scheme
Replies the scheme of this name.
Constructor Summary
Constructor and description
new(URI)
Action Summary
Modifier and type Action and description
int compareTo(SarlName)
final java.lang.Object getAssociatedObject
Replies the associated object.
java.lang.String getFragment
Replies the name of the fragment.
java.lang.String getScheme
Replies the scheme of this name.
boolean hasFragment
Replies if this name has a fragment associated to it.
boolean operator_equals(SarlName)
Compares this name with the specified name for order and determines if they are equal.
boolean operator_greaterEqualsThan(SarlName)
Compares this name with the specified name for order and determines if this name is greater than or equal to the given name.
boolean operator_greaterThan(SarlName)
Compares this name with the specified name for order and determines if this name is strictly greater than the given name.
boolean operator_lessEqualsThan(SarlName)
Compares this name with the specified name for order and determines if this name is lower than or equal to the given name.
boolean operator_lessThan(SarlName)
Compares this name with the specified name for order and determines if this name is strictly lower than the given name.
boolean operator_notEquals(SarlName)
Compares this name with the specified name for order and determines if they are not equal.
int operator_spaceship(SarlName)
Compares this name with the specified name for order.
final void setAssociatedObject(Object)
Change the associated object.
java.lang.String toString
java.net.URI toURI
Replies the URI associated to this name.
Property Details
associatedObject
var associatedObject : java.lang.Object
Replies the associated object.

This property is an alias for the action: getAssociatedObject

fragment
val fragment : java.lang.String
Replies the name of the fragment.

This property is an alias for the action: getFragment

scheme
val scheme : java.lang.String
Replies the scheme of this name.

This property is an alias for the action: getScheme

Constructor Details
new(URI)
protected new(URI)
Action Details
compareTo(SarlName)
def compareTo(SarlName) : int
getAssociatedObject
def getAssociatedObject : java.lang.Object
Replies the associated object.
getFragment
def getFragment : java.lang.String
Replies the name of the fragment.
getScheme
def getScheme : java.lang.String
Replies the scheme of this name.
hasFragment
def hasFragment : boolean
Replies if this name has a fragment associated to it.
operator_equals(SarlName)
def operator_equals(SarlName) : boolean
Compares this name with the specified name for order and determines if they are equal.
Parameters:
other - the name to be compared.
Returns:
true if this name is equal to the given name.
Since:
0.15
See:
compareTo(SarlName)
operator_greaterEqualsThan(SarlName)
def operator_greaterEqualsThan(SarlName) : boolean
Compares this name with the specified name for order and determines if this name is greater than or equal to the given name.
Parameters:
other - the name to be compared.
Returns:
true if this name is greater than or equal to the given name.
Since:
0.15
See:
compareTo(SarlName)
operator_greaterThan(SarlName)
def operator_greaterThan(SarlName) : boolean
Compares this name with the specified name for order and determines if this name is strictly greater than the given name.
Parameters:
other - the name to be compared.
Returns:
true if this name is strictly greater than the given name.
Since:
0.15
See:
compareTo(SarlName)
operator_lessEqualsThan(SarlName)
def operator_lessEqualsThan(SarlName) : boolean
Compares this name with the specified name for order and determines if this name is lower than or equal to the given name.
Parameters:
other - the name to be compared.
Returns:
true if this name is lower than or equal to the given name.
Since:
0.15
See:
compareTo(SarlName)
operator_lessThan(SarlName)
def operator_lessThan(SarlName) : boolean
Compares this name with the specified name for order and determines if this name is strictly lower than the given name.
Parameters:
other - the name to be compared.
Returns:
true if this name is strictly lower than the given name.
Since:
0.15
See:
compareTo(SarlName)
operator_notEquals(SarlName)
def operator_notEquals(SarlName) : boolean
Compares this name with the specified name for order and determines if they are not equal.
Parameters:
other - the name to be compared.
Returns:
true if this name is not equal to the given name.
Since:
0.15
See:
compareTo(SarlName)
operator_spaceship(SarlName)
def operator_spaceship(SarlName) : int
Compares this name with the specified name for order. Returns a integer, zero, or a positive integer as this name is less than, equal to, or greater than the specified object.
Parameters:
other - the name to be compared.
Returns:
a negative integer, zero, or a positive integer as this name is less than, equal to, or greater than the specified name.
Since:
0.15
See:
compareTo(SarlName)
setAssociatedObject(Object)
def setAssociatedObject(Object)
Change the associated object.
toString
def toString : java.lang.String
toURI
def toURI : java.net.URI
Replies the URI associated to this name.