Jonathan Hart

Clean up javadocs for extension treatment framework.

Change-Id: I56d53ce4b761e1f84907b7eaeb4340c4405f5588
...@@ -22,13 +22,13 @@ import org.onosproject.net.flow.instructions.ExtensionTreatment; ...@@ -22,13 +22,13 @@ import org.onosproject.net.flow.instructions.ExtensionTreatment;
22 import org.onosproject.net.flow.instructions.ExtensionTreatmentType; 22 import org.onosproject.net.flow.instructions.ExtensionTreatmentType;
23 23
24 /** 24 /**
25 - * Provides access to the extension implemented by this driver. 25 + * Provides access to the extension treatments implemented by this driver.
26 */ 26 */
27 @Beta 27 @Beta
28 public interface ExtensionTreatmentResolver extends HandlerBehaviour { 28 public interface ExtensionTreatmentResolver extends HandlerBehaviour {
29 29
30 /** 30 /**
31 - * Gets an extension instruction instance of the specified type, if supported 31 + * Gets an extension treatment instance of the specified type, if supported
32 * by the driver. 32 * by the driver.
33 * 33 *
34 * @param type type of extension to get 34 * @param type type of extension to get
......
...@@ -19,12 +19,12 @@ package org.onosproject.net.flow.instructions; ...@@ -19,12 +19,12 @@ package org.onosproject.net.flow.instructions;
19 import org.onosproject.net.flow.Extension; 19 import org.onosproject.net.flow.Extension;
20 20
21 /** 21 /**
22 - * An extenstion for the treatment API. 22 + * An extension for the treatment API.
23 */ 23 */
24 public interface ExtensionTreatment extends Extension { 24 public interface ExtensionTreatment extends Extension {
25 25
26 /** 26 /**
27 - * Gets the type of the extension instruction. 27 + * Gets the type of the treatment extension.
28 * 28 *
29 * @return type 29 * @return type
30 */ 30 */
......
...@@ -32,11 +32,10 @@ public final class ExtensionTreatmentType { ...@@ -32,11 +32,10 @@ public final class ExtensionTreatmentType {
32 * These numbers have no impact on the actual OF type id. 32 * These numbers have no impact on the actual OF type id.
33 */ 33 */
34 public enum ExtensionTreatmentTypes { 34 public enum ExtensionTreatmentTypes {
35 - // TODO fix type numbers to include experimenter id
36 NICIRA_SET_TUNNEL_DST(0), 35 NICIRA_SET_TUNNEL_DST(0),
37 NICIRA_RESUBMIT(1), 36 NICIRA_RESUBMIT(1),
38 - NICIRA_SET_NSH_SPI(32),
39 NICIRA_RESUBMIT_TABLE(14), 37 NICIRA_RESUBMIT_TABLE(14),
38 + NICIRA_SET_NSH_SPI(32),
40 NICIRA_SET_NSH_SI(33), 39 NICIRA_SET_NSH_SI(33),
41 NICIRA_SET_NSH_CH1(34), 40 NICIRA_SET_NSH_CH1(34),
42 NICIRA_SET_NSH_CH2(35), 41 NICIRA_SET_NSH_CH2(35),
...@@ -46,7 +45,7 @@ public final class ExtensionTreatmentType { ...@@ -46,7 +45,7 @@ public final class ExtensionTreatmentType {
46 private ExtensionTreatmentType type; 45 private ExtensionTreatmentType type;
47 46
48 /** 47 /**
49 - * Creates a new named extension instruction type. 48 + * Creates a new named extension treatment type.
50 * 49 *
51 * @param type type code 50 * @param type type code
52 */ 51 */
......
...@@ -24,34 +24,34 @@ import org.projectfloodlight.openflow.protocol.OFFactory; ...@@ -24,34 +24,34 @@ import org.projectfloodlight.openflow.protocol.OFFactory;
24 import org.projectfloodlight.openflow.protocol.action.OFAction; 24 import org.projectfloodlight.openflow.protocol.action.OFAction;
25 25
26 /** 26 /**
27 - * Interprets extension instructions and converts them to/from OpenFlow objects. 27 + * Interprets extension treatments and converts them to/from OpenFlow objects.
28 */ 28 */
29 @Beta 29 @Beta
30 public interface ExtensionTreatmentInterpreter extends HandlerBehaviour { 30 public interface ExtensionTreatmentInterpreter extends HandlerBehaviour {
31 31
32 /** 32 /**
33 - * Returns true if the given extension instruction is supported by this 33 + * Returns true if the given extension treatment is supported by this
34 * driver. 34 * driver.
35 * 35 *
36 - * @param extensionTreatmentType extension instruction type 36 + * @param extensionTreatmentType extension treatment type
37 - * @return true if the instruction is supported, otherwise false 37 + * @return true if the extension is supported, otherwise false
38 */ 38 */
39 boolean supported(ExtensionTreatmentType extensionTreatmentType); 39 boolean supported(ExtensionTreatmentType extensionTreatmentType);
40 40
41 /** 41 /**
42 - * Maps an extension instruction to an OpenFlow action. 42 + * Maps an extension treatment to an OpenFlow action.
43 * 43 *
44 * @param factory OpenFlow factory 44 * @param factory OpenFlow factory
45 - * @param extensionTreatment extension instruction 45 + * @param extensionTreatment extension treatment
46 * @return OpenFlow action 46 * @return OpenFlow action
47 */ 47 */
48 OFAction mapInstruction(OFFactory factory, ExtensionTreatment extensionTreatment); 48 OFAction mapInstruction(OFFactory factory, ExtensionTreatment extensionTreatment);
49 49
50 /** 50 /**
51 - * Maps an OpenFlow action to an extension instruction. 51 + * Maps an OpenFlow action to an extension treatment.
52 * 52 *
53 * @param action OpenFlow action 53 * @param action OpenFlow action
54 - * @return extension instruction 54 + * @return extension treatment
55 */ 55 */
56 ExtensionTreatment mapAction(OFAction action); 56 ExtensionTreatment mapAction(OFAction action);
57 57
......