org.omg.dds.core

Class InstanceHandle

java.lang.Object

org.omg.dds.core.InstanceHandle

All Implemented Interfaces:

Serializable, Comparable<InstanceHandle>, DDSObject

Direct Known Subclasses:

ModifiableInstanceHandle

public abstract class InstanceHandle
extends Object
implements Comparable<InstanceHandle>, Serializable, DDSObject

An opaque handle that can be used to refer to a local or remote entity.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceHandle()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	isNil()
abstract ModifiableInstanceHandle	modifiableCopy()
static ModifiableInstanceHandle	newInstanceHandle(ServiceEnvironment env)
static InstanceHandle	nilHandle(ServiceEnvironment env)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Constructor Detail

InstanceHandle

public InstanceHandle()

Method Detail

newInstanceHandle

public static ModifiableInstanceHandle newInstanceHandle(ServiceEnvironment env)

Parameters:

env - Identifies the Service instance to which the new object will belong.

nilHandle

public static InstanceHandle nilHandle(ServiceEnvironment env)

Parameters:

env - Identifies the Service instance to which the object will belong.

Returns:

An unmodifiable nil instance handle.

isNil

public abstract boolean isNil()

modifiableCopy

public abstract ModifiableInstanceHandle modifiableCopy()

Returns:

a modifiable copy of this object's state.