cleanup and javadoc for remaining files in onos.core.intent
Change-Id: I3bfe85579daa4bb35be6133b3221fabd80b10e00
diff --git a/src/main/java/net/onrc/onos/core/intent/ConstrainedShortestPathIntent.java b/src/main/java/net/onrc/onos/core/intent/ConstrainedShortestPathIntent.java
index 1661c02..0d842eb 100644
--- a/src/main/java/net/onrc/onos/core/intent/ConstrainedShortestPathIntent.java
+++ b/src/main/java/net/onrc/onos/core/intent/ConstrainedShortestPathIntent.java
@@ -1,7 +1,9 @@
package net.onrc.onos.core.intent;
/**
- * @author Toshio Koide (t-koide@onlab.us)
+ * The ConstrainedShortestPathIntent is a "high-level" intent that allows
+ * applications to reserve bandwith along the shortest available path between
+ * specified endpoints.
*/
public class ConstrainedShortestPathIntent extends ShortestPathIntent {
protected double bandwidth;
@@ -12,6 +14,19 @@
protected ConstrainedShortestPathIntent() {
}
+ /**
+ * Constructor.
+ *
+ * @param id the ID for this Intent
+ * @param srcSwitch Source Switch DPID
+ * @param srcPort Source Port
+ * @param srcMac Source Host MAC Address
+ * @param dstSwitch Destination Switch DPID
+ * @param dstPort Destination Port
+ * @param dstMac Destination Host MAC Address
+ * @param bandwidth bandwidth which should be allocated for the path.
+ * If 0, no intent for bandwidth allocation (best effort).
+ */
// CHECKSTYLE:OFF suppress the warning about too many parameters
public ConstrainedShortestPathIntent(String id,
long srcSwitch, long srcPort, long srcMac,
@@ -22,19 +37,34 @@
this.bandwidth = bandwidth;
}
+ /**
+ * Get the bandwidth specified for this Intent.
+ * TODO: specify unit
+ *
+ * @return this Intent's bandwidth
+ */
public double getBandwidth() {
return bandwidth;
}
+ /**
+ * Generates a hash code using the Intent ID.
+ *
+ * @return hashcode
+ */
@Override
public int hashCode() {
- // TODO: Is this the intended behavior?
- return (super.hashCode());
+ return super.hashCode();
}
+ /**
+ * Compares two intent object by type (class) and Intent ID.
+ *
+ * @param obj other Intent
+ * @return true if equal, false otherwise
+ */
@Override
public boolean equals(Object obj) {
- // TODO: Is this the intended behavior?
- return (super.equals(obj));
+ return super.equals(obj);
}
}