diff options
author | gjoranv <gv@verizonmedia.com> | 2019-06-04 21:56:54 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-04 21:56:54 +0200 |
commit | c9f94011aad091427dd66a2b595013e6cd2bfff6 (patch) | |
tree | 8f15d2ae1a1368617896497c87b4446e984f28ca /metrics-proxy | |
parent | a8a2a62e048ee97ee7e7819ae02e80ad03e04cea (diff) |
Fix comments
Diffstat (limited to 'metrics-proxy')
-rw-r--r-- | metrics-proxy/src/main/java/ai/vespa/metricsproxy/metric/model/json/JsonRenderingException.java | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/metrics-proxy/src/main/java/ai/vespa/metricsproxy/metric/model/json/JsonRenderingException.java b/metrics-proxy/src/main/java/ai/vespa/metricsproxy/metric/model/json/JsonRenderingException.java index 6ad8da13073..4c1d42d75ee 100644 --- a/metrics-proxy/src/main/java/ai/vespa/metricsproxy/metric/model/json/JsonRenderingException.java +++ b/metrics-proxy/src/main/java/ai/vespa/metricsproxy/metric/model/json/JsonRenderingException.java @@ -13,7 +13,8 @@ import java.util.logging.Logger; import static java.util.logging.Level.WARNING; /** - * An exception whose message is always valid json or, if all fails, a plain text string. + * An exception to be thrown upon errors in json rendering, and that can deliver its message wrapped + * in an "error" json object. * * @author gjoranv */ @@ -25,6 +26,10 @@ public class JsonRenderingException extends RuntimeException { super(message); } + /** + * Returns the message wrapped in an "error" json object. In the unlikely case that json rendering of the + * error message fails, a plain text string will be returned instead. + */ public String getMessageAsJson() { return wrap(getMessage()); } |