cleanup and javadoc for remaining files in onos.core.intent
Change-Id: I3bfe85579daa4bb35be6133b3221fabd80b10e00
diff --git a/src/main/java/net/onrc/onos/core/intent/ErrorIntent.java b/src/main/java/net/onrc/onos/core/intent/ErrorIntent.java
index c1722fd..7a5d04a 100644
--- a/src/main/java/net/onrc/onos/core/intent/ErrorIntent.java
+++ b/src/main/java/net/onrc/onos/core/intent/ErrorIntent.java
@@ -2,13 +2,22 @@
/**
* This class is instantiated by Run-times to express intent calculation error.
- *
- * @author Toshio Koide (t-koide@onlab.us)
*/
public class ErrorIntent extends Intent {
public enum ErrorType {
+ /**
+ * Intent not supported by runtime.
+ */
UNSUPPORTED_INTENT,
+
+ /**
+ * One or more of the switches refereneced by this Intent not found.
+ */
SWITCH_NOT_FOUND,
+
+ /**
+ * Path specified by Intent is not in the topology.
+ */
PATH_NOT_FOUND,
}
@@ -22,6 +31,13 @@
protected ErrorIntent() {
}
+ /**
+ * Constructor.
+ *
+ * @param errorType error type
+ * @param message human-readable error string
+ * @param parentIntent related parent Intent
+ */
public ErrorIntent(ErrorType errorType, String message, Intent parentIntent) {
super(parentIntent.getId());
this.errorType = errorType;
@@ -29,15 +45,24 @@
this.parentIntent = parentIntent;
}
+ /**
+ * 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);
}
}