cleanup and javadoc for remaining files in onos.core.intent
Change-Id: I3bfe85579daa4bb35be6133b3221fabd80b10e00
diff --git a/src/main/java/net/onrc/onos/core/intent/IntentOperation.java b/src/main/java/net/onrc/onos/core/intent/IntentOperation.java
index 0cb42ff..5233e26 100644
--- a/src/main/java/net/onrc/onos/core/intent/IntentOperation.java
+++ b/src/main/java/net/onrc/onos/core/intent/IntentOperation.java
@@ -1,7 +1,9 @@
package net.onrc.onos.core.intent;
/**
- * @author Toshio Koide (t-koide@onlab.us)
+ * This class is merely an Intent and an associated operation.
+ * <p>
+ * It exists so that the pair can be serialized for notifications and persistence.
*/
public class IntentOperation {
public enum Operator {
@@ -26,14 +28,28 @@
public Operator operator;
public Intent intent;
+ /**
+ * Default Constructor.
+ */
protected IntentOperation() {
}
+ /**
+ * Constructor.
+ *
+ * @param operator the operation to perform for this Intent
+ * @param intent the Intent
+ */
public IntentOperation(Operator operator, Intent intent) {
this.operator = operator;
this.intent = intent;
}
+ /**
+ * Returns a string representation of the operation and Intent.
+ *
+ * @return "operator, (Intent ID)"
+ */
@Override
public String toString() {
return operator.toString() + ", (" + intent.toString() + ")";