Convert to using requireNonNull()

[netconf.git] / netconf / netconf-topology-singleton / src / main / java / org / opendaylight / netconf / topology / singleton / api / RemoteDeviceConnector.java

diff --git a/netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/api/RemoteDeviceConnector.java b/netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/api/RemoteDeviceConnector.java
index 69e2dd20bd494660d3b40f3703824f1189e28a05..97d067dae5ab29e13d0f898a377d12f205ff27ca 100644 (file)
--- a/netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/api/RemoteDeviceConnector.java
+++ b/netconf/netconf-topology-singleton/src/main/java/org/opendaylight/netconf/topology/singleton/api/RemoteDeviceConnector.java
@@ -5,24 +5,29 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.topology.singleton.api;
 
 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler;
 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
 
 /**
- * Provides API for connection odl (master) with device.
+ * Provides API for connection ODL (master) with device.
  */
+// FIXME: way more documentation is needed here
 public interface RemoteDeviceConnector {
 
     /**
      * Create device communicator and open device connection.
+     *
+     * @param deviceHandler Device handler
+     * @throws NullPointerException if {@code deviceHandler} is null
      */
+    // FIXME: this should return a resource corresponding to the device connection
     void startRemoteDeviceConnection(RemoteDeviceHandler<NetconfSessionPreferences> deviceHandler);
 
     /**
      * Stop device communicator.
      */
+    // FIXME: see above, this should live in the returned resource
     void stopRemoteDeviceConnection();
 }