adding javadoc to intent classes: Action, FlowEntry, ForwardAction, Match
Change-Id: Ia7d6475adc7c88430deeb182e22604d766252c2c
diff --git a/src/main/java/net/onrc/onos/core/intent/ForwardAction.java b/src/main/java/net/onrc/onos/core/intent/ForwardAction.java
index 4e4088f..f0d09cb 100644
--- a/src/main/java/net/onrc/onos/core/intent/ForwardAction.java
+++ b/src/main/java/net/onrc/onos/core/intent/ForwardAction.java
@@ -3,20 +3,35 @@
import net.onrc.onos.core.util.FlowEntryAction;
/**
- * @author Brian O'Connor <bocon@onlab.us>
+ * A class to represent the OpenFlow forwarding action.
*/
class ForwardAction extends Action {
protected long dstPort;
+ /**
+ * Constructor.
+ *
+ * @param dstPort the destination port to forward packets
+ */
public ForwardAction(long dstPort) {
this.dstPort = dstPort;
}
+ /**
+ * Returns a String representation of this ForwardAction.
+ *
+ * @return the destination port as a String
+ */
public String toString() {
return Long.toString(dstPort);
}
+ /**
+ * Converts the FowardAction into a legacy FlowEntryAction object.
+ *
+ * @return an equivalent FlowEntryAction object
+ */
@Override
public FlowEntryAction getFlowEntryAction() {
FlowEntryAction action = new FlowEntryAction();
@@ -24,10 +39,21 @@
return action;
}
+ /**
+ * A simple hash function that just used the destination port.
+ *
+ * @return hashcode
+ */
public int hashCode() {
return (int) dstPort;
}
+ /**
+ * Objects are equal if they share a destination port.
+ *
+ * @params o another object to compare to this
+ * @return true if equal, false otherwise
+ */
public boolean equals(Object o) {
if (!(o instanceof ForwardAction)) {
return false;