update javadoc following PR review
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-client/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-client/commit/cf15eb42 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-client/tree/cf15eb42 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-client/diff/cf15eb42 Branch: refs/heads/master Commit: cf15eb429e1130f031ce7facd57c8c54259e151c Parents: 51c05d8 Author: Alex Heneveld <[email protected]> Authored: Tue May 9 14:26:19 2017 +0100 Committer: Alex Heneveld <[email protected]> Committed: Tue May 9 14:26:19 2017 +0100 ---------------------------------------------------------------------- .../main/java/org/apache/brooklyn/rest/client/BrooklynApi.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-client/blob/cf15eb42/java/src/main/java/org/apache/brooklyn/rest/client/BrooklynApi.java ---------------------------------------------------------------------- diff --git a/java/src/main/java/org/apache/brooklyn/rest/client/BrooklynApi.java b/java/src/main/java/org/apache/brooklyn/rest/client/BrooklynApi.java index 90a5332..0b127d6 100644 --- a/java/src/main/java/org/apache/brooklyn/rest/client/BrooklynApi.java +++ b/java/src/main/java/org/apache/brooklyn/rest/client/BrooklynApi.java @@ -405,8 +405,9 @@ public class BrooklynApi { return getEntity(response, type); } - /** This fails if it is clearly an ApiError response which the caller did not want. - * To fail on any error (probably better), use */ + /** Fails if the response is clearly an ApiError response which the caller did not want. + * To fail on any error (probably better), callers will normally use the {@link #getEntityOnSuccess(Response, Class)} method, + * or {@link #getEntity(Response, Class)} if preferring to ignore errors. */ private static <T> void failSomeErrors(Response response, Class<?> type, boolean onlyIfItLooksLikeApiError) { if (response.getStatus()<400) { // not an error
