added javadocs and comments
diff --git a/src/main/java/org.onosproject.xran/controller/XranController.java b/src/main/java/org.onosproject.xran/controller/XranController.java
index 0ab91ef..b08c714 100644
--- a/src/main/java/org.onosproject.xran/controller/XranController.java
+++ b/src/main/java/org.onosproject.xran/controller/XranController.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2015-present Open Networking Laboratory
+ * Copyright 2015-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -28,23 +28,73 @@
*/
public interface XranController {
+ /**
+ * Send a HandOff request from one link to another.
+ *
+ * @param newLink target LINK entity
+ * @param oldLink source LINK entity
+ * @return blocking queue for RESPONSE
+ * @throws InterruptedException interrupted exception
+ */
SynchronousQueue<String> sendHORequest(RnibLink newLink, RnibLink oldLink) throws InterruptedException;
+ /**
+ * Add a device listener for CELL connections.
+ *
+ * @param listener listener
+ */
void addListener(XranDeviceListener listener);
+ /**
+ * Add a host listener for UE connections.
+ *
+ * @param listener listener
+ */
void addListener(XranHostListener listener);
+ /**
+ * Remove a CELL device listener.
+ *
+ * @param listener listener
+ */
void removeListener(XranDeviceListener listener);
+ /**
+ * Remove a UE host listener.
+ *
+ * @param listener listener
+ */
void removeListener(XranHostListener listener);
- SynchronousQueue<String> sendModifiedRRMConf(RRMConfig rrmConfig, boolean xICIC);
+ /**
+ * Send modified RRM configuration or xICICConfing.
+ *
+ * @param rrmConfig configuration fields to send
+ * @param xicic if true sends xicic else it sends RRM
+ * @return blocking queue for RESPONSE
+ */
+ SynchronousQueue<String> sendmodifiedrrmconf(RRMConfig rrmConfig, boolean xicic);
+ /**
+ * Send scell add packet for specified LINK.
+ *
+ * @param link LINK entity
+ * @return blocking queue for RESPONSE
+ */
SynchronousQueue<String> sendScellAdd(RnibLink link);
+ /**
+ * Send scell delete for specified LINK.
+ *
+ * @param link LINK entity
+ * @return true if sent correctly
+ */
boolean sendScellDelete(RnibLink link);
- int getNorthbound_timeout();
-
- void setNorthbound_timeout(int northbound_timeout);
+ /**
+ * Get northbound timeout.
+ *
+ * @return interval in milliseconds
+ */
+ int getNorthboundTimeout();
}