io.sarl.lang.core

Class Address

java.lang.Object

io.sarl.lang.core.SRESpecificDataContainer

io.sarl.lang.core.Address

All Implemented Interfaces:

Serializable, Comparable<Address>

public class Address
extends SRESpecificDataContainer
implements Serializable, Comparable<Address>

This class describes all the addresses used by the kernel to identify its elements.

Version:

0.8.0 2018-09-23 23:08:17

Author:

Sebastian Rodriguez

See Also:

Serialized Form

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Constructor Summary

Constructors

Constructor and Description
Address(spaceId : SpaceID, agentId : UUID) Create an address based on the specified identifier.

Method Summary

Modifier and Type	Method and Description
int	compareTo(address : Address) Compares this object with the specified object for order.
boolean	equals(address : Address) Test if this address and the given one are equal.
boolean	equals(obj : Object)
SpaceID	getSpaceId() Deprecated. since 0.7, see Address.getSpaceID() for replacement.
SpaceID	getSpaceID() Replies the ID of the space related to this address.
UUID	getUUID() Replies the identifier associated to this address.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public new(spaceId : SpaceID,
           agentId : UUID)

Create an address based on the specified identifier.

Parameters:

spaceId - the identifier of the space related to this address.

agentId - is the identifier of the address.

Method Detail

toString

@Pure
public def toString() : String 

Overrides:

toString in class Object

getUUID

@Pure
public def getUUID() : UUID 

Description copied from class: Address

Replies the identifier associated to this address.

Returns:

the identifier associated to this address.

hashCode

@Pure
public def hashCode() : int 

Overrides:

hashCode in class Object

equals

@Pure
public def equals(obj : Object) : boolean 

Overrides:

equals in class Object

equals

@Pure
public def equals(address : Address) : boolean 

Description copied from class: Address

Test if this address and the given one are equal.

Parameters:

address - is the address to be compared.

Returns:

true if this address and the given one are equal, otherwise false

compareTo

@Pure
public def compareTo(address : Address) : int 

Description copied from class: Address

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

In the foregoing description, the notation sgn(expression ) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.

Specified by:

compareTo in interface Comparable<Address>

Parameters:

address - is the address to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

getSpaceID

@Pure
public def getSpaceID() : SpaceID 

Description copied from class: Address

Replies the ID of the space related to this address.

Returns:

the space ID.

Since:

0.7

getSpaceId

@Pure
 @Deprecated
public def getSpaceId() : SpaceID 

Deprecated. since 0.7, see Address.getSpaceID() for replacement.

Description copied from class: Address

Replies the ID of the space related to this address.

Returns:

the space ID.