Update flow rule service javadoc to avoid confusion around groups.
Change-Id: I66b3185ed6e5294ae6f0fd6327a106affa880736
Showing
1 changed file
with
9 additions
and
3 deletions
... | @@ -89,10 +89,16 @@ public interface FlowRuleService | ... | @@ -89,10 +89,16 @@ public interface FlowRuleService |
89 | Iterable<FlowRule> getFlowRulesById(ApplicationId id); | 89 | Iterable<FlowRule> getFlowRulesById(ApplicationId id); |
90 | 90 | ||
91 | /** | 91 | /** |
92 | - * Returns a list of rules filterd by application and group id. | 92 | + * Returns a list of rules filtered by application and group id. |
93 | + * <p> | ||
94 | + * Note that the group concept here is simply a logical grouping of flows. | ||
95 | + * This is not the same as a group in the | ||
96 | + * {@link org.onosproject.net.group.GroupService}, and this method will not | ||
97 | + * return flows that are mapped to a particular {@link org.onosproject.net.group.Group}. | ||
98 | + * </p> | ||
93 | * | 99 | * |
94 | - * @param appId the application id to lookup | 100 | + * @param appId the application ID to look up |
95 | - * @param groupId the groupid to lookup | 101 | + * @param groupId the group ID to look up |
96 | * @return collection of flow rules | 102 | * @return collection of flow rules |
97 | */ | 103 | */ |
98 | Iterable<FlowRule> getFlowRulesByGroupId(ApplicationId appId, short groupId); | 104 | Iterable<FlowRule> getFlowRulesByGroupId(ApplicationId appId, short groupId); | ... | ... |
-
Please register or login to post a comment