Committed by
Gerrit Code Review
Follow the convention of javadoc used in the project
Insert a blank line between the brief desciption and paramter description. Change-Id: Iad27f20aa862f84a4278624f0df75f98ab9e543f
Showing
3 changed files
with
14 additions
and
0 deletions
| ... | @@ -22,24 +22,28 @@ public interface Load { | ... | @@ -22,24 +22,28 @@ public interface Load { |
| 22 | 22 | ||
| 23 | /** | 23 | /** |
| 24 | * Obtain the current observed rate (in bytes/s) on a link. | 24 | * Obtain the current observed rate (in bytes/s) on a link. |
| 25 | + * | ||
| 25 | * @return long value | 26 | * @return long value |
| 26 | */ | 27 | */ |
| 27 | long rate(); | 28 | long rate(); |
| 28 | 29 | ||
| 29 | /** | 30 | /** |
| 30 | * Obtain the latest bytes counter viewed on that link. | 31 | * Obtain the latest bytes counter viewed on that link. |
| 32 | + * | ||
| 31 | * @return long value | 33 | * @return long value |
| 32 | */ | 34 | */ |
| 33 | long latest(); | 35 | long latest(); |
| 34 | 36 | ||
| 35 | /** | 37 | /** |
| 36 | * Indicates whether this load was built on valid values. | 38 | * Indicates whether this load was built on valid values. |
| 39 | + * | ||
| 37 | * @return boolean | 40 | * @return boolean |
| 38 | */ | 41 | */ |
| 39 | boolean isValid(); | 42 | boolean isValid(); |
| 40 | 43 | ||
| 41 | /** | 44 | /** |
| 42 | * Returns when this value was seen. | 45 | * Returns when this value was seen. |
| 46 | + * | ||
| 43 | * @return epoch time | 47 | * @return epoch time |
| 44 | */ | 48 | */ |
| 45 | long time(); | 49 | long time(); | ... | ... |
| ... | @@ -29,6 +29,7 @@ public interface StatisticService { | ... | @@ -29,6 +29,7 @@ public interface StatisticService { |
| 29 | 29 | ||
| 30 | /** | 30 | /** |
| 31 | * Obtain the load for a the ingress to the given link. | 31 | * Obtain the load for a the ingress to the given link. |
| 32 | + * | ||
| 32 | * @param link the link to query. | 33 | * @param link the link to query. |
| 33 | * @return a {@link org.onlab.onos.net.statistic.Load Load} | 34 | * @return a {@link org.onlab.onos.net.statistic.Load Load} |
| 34 | */ | 35 | */ |
| ... | @@ -36,6 +37,7 @@ public interface StatisticService { | ... | @@ -36,6 +37,7 @@ public interface StatisticService { |
| 36 | 37 | ||
| 37 | /** | 38 | /** |
| 38 | * Obtain the load for the given port. | 39 | * Obtain the load for the given port. |
| 40 | + * | ||
| 39 | * @param connectPoint the port to query | 41 | * @param connectPoint the port to query |
| 40 | * @return a {@link org.onlab.onos.net.statistic.Load} | 42 | * @return a {@link org.onlab.onos.net.statistic.Load} |
| 41 | */ | 43 | */ |
| ... | @@ -43,6 +45,7 @@ public interface StatisticService { | ... | @@ -43,6 +45,7 @@ public interface StatisticService { |
| 43 | 45 | ||
| 44 | /** | 46 | /** |
| 45 | * Find the most loaded link along a path. | 47 | * Find the most loaded link along a path. |
| 48 | + * | ||
| 46 | * @param path the path to search in | 49 | * @param path the path to search in |
| 47 | * @return the most loaded {@link org.onlab.onos.net.Link}. | 50 | * @return the most loaded {@link org.onlab.onos.net.Link}. |
| 48 | */ | 51 | */ |
| ... | @@ -50,6 +53,7 @@ public interface StatisticService { | ... | @@ -50,6 +53,7 @@ public interface StatisticService { |
| 50 | 53 | ||
| 51 | /** | 54 | /** |
| 52 | * Find the least loaded link along a path. | 55 | * Find the least loaded link along a path. |
| 56 | + * | ||
| 53 | * @param path the path to search in | 57 | * @param path the path to search in |
| 54 | * @return the least loaded {@link org.onlab.onos.net.Link}. | 58 | * @return the least loaded {@link org.onlab.onos.net.Link}. |
| 55 | */ | 59 | */ |
| ... | @@ -58,6 +62,7 @@ public interface StatisticService { | ... | @@ -58,6 +62,7 @@ public interface StatisticService { |
| 58 | /** | 62 | /** |
| 59 | * Returns the highest hitter (a flow rule) for a given port, ie. the | 63 | * Returns the highest hitter (a flow rule) for a given port, ie. the |
| 60 | * flow rule which is generating the most load. | 64 | * flow rule which is generating the most load. |
| 65 | + * | ||
| 61 | * @param connectPoint the port | 66 | * @param connectPoint the port |
| 62 | * @return the flow rule | 67 | * @return the flow rule |
| 63 | */ | 68 | */ | ... | ... |
| ... | @@ -28,24 +28,28 @@ public interface StatisticStore { | ... | @@ -28,24 +28,28 @@ public interface StatisticStore { |
| 28 | 28 | ||
| 29 | /** | 29 | /** |
| 30 | * Lay the foundation for receiving flow stats for this rule. | 30 | * Lay the foundation for receiving flow stats for this rule. |
| 31 | + * | ||
| 31 | * @param rule a {@link org.onlab.onos.net.flow.FlowRule} | 32 | * @param rule a {@link org.onlab.onos.net.flow.FlowRule} |
| 32 | */ | 33 | */ |
| 33 | void prepareForStatistics(FlowRule rule); | 34 | void prepareForStatistics(FlowRule rule); |
| 34 | 35 | ||
| 35 | /** | 36 | /** |
| 36 | * Remove entries associated with this rule. | 37 | * Remove entries associated with this rule. |
| 38 | + * | ||
| 37 | * @param rule {@link org.onlab.onos.net.flow.FlowRule} | 39 | * @param rule {@link org.onlab.onos.net.flow.FlowRule} |
| 38 | */ | 40 | */ |
| 39 | void removeFromStatistics(FlowRule rule); | 41 | void removeFromStatistics(FlowRule rule); |
| 40 | 42 | ||
| 41 | /** | 43 | /** |
| 42 | * Adds a stats observation for a flow rule. | 44 | * Adds a stats observation for a flow rule. |
| 45 | + * | ||
| 43 | * @param rule a {@link org.onlab.onos.net.flow.FlowEntry} | 46 | * @param rule a {@link org.onlab.onos.net.flow.FlowEntry} |
| 44 | */ | 47 | */ |
| 45 | void addOrUpdateStatistic(FlowEntry rule); | 48 | void addOrUpdateStatistic(FlowEntry rule); |
| 46 | 49 | ||
| 47 | /** | 50 | /** |
| 48 | * Fetches the current observed stats values. | 51 | * Fetches the current observed stats values. |
| 52 | + * | ||
| 49 | * @param connectPoint the port to fetch information for | 53 | * @param connectPoint the port to fetch information for |
| 50 | * @return set of current flow rules | 54 | * @return set of current flow rules |
| 51 | */ | 55 | */ |
| ... | @@ -53,6 +57,7 @@ public interface StatisticStore { | ... | @@ -53,6 +57,7 @@ public interface StatisticStore { |
| 53 | 57 | ||
| 54 | /** | 58 | /** |
| 55 | * Fetches the current observed stats values. | 59 | * Fetches the current observed stats values. |
| 60 | + * | ||
| 56 | * @param connectPoint the port to fetch information for | 61 | * @param connectPoint the port to fetch information for |
| 57 | * @return set of current values | 62 | * @return set of current values |
| 58 | */ | 63 | */ | ... | ... |
-
Please register or login to post a comment