OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
InstanceHandle.java
Go to the documentation of this file.
1 /* Copyright 2010, Object Management Group, Inc.
2  * Copyright 2010, PrismTech, Inc.
3  * Copyright 2010, Real-Time Innovations, Inc.
4  * All rights reserved.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 package org.omg.dds.core;
20 
21 import java.io.Serializable;
22 
23 
27 public abstract class InstanceHandle
28 implements Comparable<InstanceHandle>, Serializable, DDSObject
29 {
30  // -----------------------------------------------------------------------
31  // Private Constants
32  // -----------------------------------------------------------------------
33 
34  private static final long serialVersionUID = 4987266126475078295L;
35 
43  {
44  return env.getSPI().nilHandle();
45  }
46 
47 
48 
49  // -----------------------------------------------------------------------
50  // Instance Methods
51  // -----------------------------------------------------------------------
52 
53  public abstract boolean isNil();
54 }
abstract ServiceProviderInterface getSPI()
This method is not intended for use by applications.
An opaque handle that can be used to refer to a local or remote entity.
A supertype of all DDS classes and interfaces.
Definition: DDSObject.java:25
static InstanceHandle nilHandle(ServiceEnvironment env)
DDS implementations are rooted in this class, a concrete subclass of which can be instantiated based ...