org.npsnet.xrti
Class XRTIRegionHandle

java.lang.Object
  org.npsnet.xrti.XRTIRegionHandle

All Implemented Interfaces:

RegionHandle, java.io.Serializable

public class XRTIRegionHandle

extends java.lang.Object

implements RegionHandle

A type-safe handle for a region.

Author:

Andrzej Kapolka

See Also:

Serialized Form

Field Summary

private long

identifier The region identifier.

Constructor Summary

protected

XRTIRegionHandle(long pIdentifier) Constructor.

Method Summary

boolean	equals(java.lang.Object otherRegionHandle) Checks this region handle for equality with another.
protected long	getIdentifier() Returns this handle's unique identifier.
int	hashCode() Computes and returns a hash code corresponding to this region handle.
java.lang.String	toString() Returns a string representation of this region handle.

Methods inherited from class java.lang.Object

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

Field Detail

identifier

private long identifier

The region identifier.

Constructor Detail

XRTIRegionHandle

protected XRTIRegionHandle(long pIdentifier)

Constructor.

Parameters:

pIdentifier - the region identifier

Method Detail

getIdentifier

protected long getIdentifier()

Returns this handle's unique identifier.

Returns:

this handle's unique identifier

equals

public boolean equals(java.lang.Object otherRegionHandle)

Checks this region handle for equality with another.

Specified by:

equals in interface RegionHandle

Parameters:

otherRegionHandle - the other region handle

Returns:

true if the two handles represent the same region, false otherwise

hashCode

public int hashCode()

Computes and returns a hash code corresponding to this region handle.

Specified by:

hashCode in interface RegionHandle

Returns:

the hash code corresponding to this region handle

toString

public java.lang.String toString()

Returns a string representation of this region handle.

Specified by:

toString in interface RegionHandle

Returns:

a string representation of this region handle