Small clarifications to FlowRuleService javadocs.
Change-Id: If15f4e1818542f07a3653416ced85cdd3fe01277
Showing
1 changed file
with
4 additions
and
8 deletions
| ... | @@ -51,8 +51,6 @@ public interface FlowRuleService | ... | @@ -51,8 +51,6 @@ public interface FlowRuleService |
| 51 | */ | 51 | */ |
| 52 | Iterable<FlowEntry> getFlowEntries(DeviceId deviceId); | 52 | Iterable<FlowEntry> getFlowEntries(DeviceId deviceId); |
| 53 | 53 | ||
| 54 | - // TODO: add createFlowRule factory method and execute operations method | ||
| 55 | - | ||
| 56 | /** | 54 | /** |
| 57 | * Applies the specified flow rules onto their respective devices. These | 55 | * Applies the specified flow rules onto their respective devices. These |
| 58 | * flow rules will be retained by the system and re-applied anytime the | 56 | * flow rules will be retained by the system and re-applied anytime the |
| ... | @@ -68,22 +66,20 @@ public interface FlowRuleService | ... | @@ -68,22 +66,20 @@ public interface FlowRuleService |
| 68 | * be removed once the device reconnects. | 66 | * be removed once the device reconnects. |
| 69 | * | 67 | * |
| 70 | * @param flowRules one or more flow rules | 68 | * @param flowRules one or more flow rules |
| 71 | - * throws SomeKindOfException that indicates which ones were removed and | ||
| 72 | - * which ones failed | ||
| 73 | */ | 69 | */ |
| 74 | void removeFlowRules(FlowRule... flowRules); | 70 | void removeFlowRules(FlowRule... flowRules); |
| 75 | 71 | ||
| 76 | /** | 72 | /** |
| 77 | - * Removes all rules by id. | 73 | + * Removes all rules submitted by a particular application. |
| 78 | * | 74 | * |
| 79 | - * @param appId id to remove | 75 | + * @param appId ID of application whose flows will be removed |
| 80 | */ | 76 | */ |
| 81 | void removeFlowRulesById(ApplicationId appId); | 77 | void removeFlowRulesById(ApplicationId appId); |
| 82 | 78 | ||
| 83 | /** | 79 | /** |
| 84 | - * Returns a list of rules with this application id. | 80 | + * Returns a list of rules with this application ID. |
| 85 | * | 81 | * |
| 86 | - * @param id the id to look up | 82 | + * @param id the application ID to look up |
| 87 | * @return collection of flow rules | 83 | * @return collection of flow rules |
| 88 | */ | 84 | */ |
| 89 | Iterable<FlowRule> getFlowRulesById(ApplicationId id); | 85 | Iterable<FlowRule> getFlowRulesById(ApplicationId id); | ... | ... |
-
Please register or login to post a comment