Adding Javadoc to ObjectiveContext methods
(Copied from master) Change-Id: I683501501ba4729b5b98d23a70dad3bb5237df5a
Showing
1 changed file
with
15 additions
and
2 deletions
... | @@ -26,8 +26,21 @@ import com.google.common.annotations.Beta; | ... | @@ -26,8 +26,21 @@ import com.google.common.annotations.Beta; |
26 | @Beta | 26 | @Beta |
27 | public interface ObjectiveContext { | 27 | public interface ObjectiveContext { |
28 | 28 | ||
29 | - default void onSuccess(Objective objective) {} | 29 | + /** |
30 | + * Invoked on successful execution of the flow objective. | ||
31 | + * | ||
32 | + * @param objective objective to execute | ||
33 | + */ | ||
34 | + default void onSuccess(Objective objective) { | ||
35 | + } | ||
30 | 36 | ||
31 | - default void onError(Objective objective, ObjectiveError error) {} | 37 | + /** |
38 | + * Invoked when error is encountered while executing the flow objective. | ||
39 | + * | ||
40 | + * @param objective objective to execute | ||
41 | + * @param error error encountered | ||
42 | + */ | ||
43 | + default void onError(Objective objective, ObjectiveError error) { | ||
44 | + } | ||
32 | 45 | ||
33 | } | 46 | } | ... | ... |
-
Please register or login to post a comment