diff options
author | Jon Bratseth <bratseth@gmail.com> | 2020-11-18 20:37:35 +0100 |
---|---|---|
committer | Jon Bratseth <bratseth@gmail.com> | 2020-11-18 20:37:35 +0100 |
commit | b01ecd72d26a45ff4b498881446f5e62237c64be (patch) | |
tree | c6b4626e262d234900929132e4554b00cda03c49 /container-core/src/main/java/com/yahoo/processing/rendering | |
parent | 804b5ea7d3822847d2b732c79fd35a5eceba15b4 (diff) |
Non-functional-changes-only
Diffstat (limited to 'container-core/src/main/java/com/yahoo/processing/rendering')
4 files changed, 12 insertions, 22 deletions
diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousRenderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousRenderer.java index b6298558ff9..eb39c4c8117 100644 --- a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousRenderer.java +++ b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousRenderer.java @@ -20,8 +20,7 @@ public abstract class AsynchronousRenderer <RESPONSE extends Response> extends R * Exposes JDisc wiring to ensure asynchronous cleanup. * * @param channel the channel to the client receiving the response - * @param completionHandler the JDisc completion handler which will be invoked at the end - * of the rendering + * @param completionHandler the JDisc completion handler which will be invoked at the end of the rendering * @throws IllegalStateException if attempted invoked more than once */ public abstract void setNetworkWiring(ContentChannel channel, CompletionHandler completionHandler); diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java index fdc3b63fc92..f86cad7c619 100644 --- a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java +++ b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java @@ -53,10 +53,8 @@ public abstract class AsynchronousSectionedRenderer<RESPONSE extends Response> e * stream to be used throughput the rendering. Subsequent calls must use the * same stream. * - * @param stream - * the stream to render to in this and all subsequent calls. - * @throws IOException - * passed on from the stream + * @param stream the stream to render to in this and all subsequent calls. + * @throws IOException passed on from the stream */ public abstract void beginResponse(OutputStream stream) throws IOException; diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/ProcessingRenderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/ProcessingRenderer.java index 556eec9b460..052c1c3f7f5 100644 --- a/container-core/src/main/java/com/yahoo/processing/rendering/ProcessingRenderer.java +++ b/container-core/src/main/java/com/yahoo/processing/rendering/ProcessingRenderer.java @@ -167,7 +167,7 @@ public class ProcessingRenderer extends AsynchronousSectionedRenderer<Response> private static class TraceRenderingVisitor extends TraceVisitor { - private JSONWriter jsonWriter; + private final JSONWriter jsonWriter; public TraceRenderingVisitor(JSONWriter jsonWriter) { this.jsonWriter = jsonWriter; @@ -226,4 +226,5 @@ public class ProcessingRenderer extends AsynchronousSectionedRenderer<Response> return (IOException) super.getCause(); } } + } diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java index d04eda943af..a7fa557f71a 100644 --- a/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java +++ b/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java @@ -46,16 +46,11 @@ public abstract class Renderer<RESPONSE extends Response> extends AbstractCompon * exception causing failure wrapped in an ExecutionException if rendering * was not successful. * - * @param stream - * a stream API bridge to JDisc - * @param response - * the response to render - * @param execution - * the execution which created this response - * @param request - * the request matching the response - * @return a ListenableFuture containing a boolean where true indicates a - * successful rendering + * @param stream a stream API bridge to JDisc + * @param response the response to render + * @param execution the execution which created this response + * @param request the request matching the response + * @return a ListenableFuture containing a boolean where true indicates a successful rendering */ public abstract ListenableFuture<Boolean> render(OutputStream stream, RESPONSE response, Execution execution, Request request); @@ -63,17 +58,14 @@ public abstract class Renderer<RESPONSE extends Response> extends AbstractCompon /** * Name of the output encoding, if applicable. * - *<p>TODO: ensure null is OK - * - * @return The encoding of the output if applicable, e.g. "utf-8" + * @return the encoding of the output if applicable, e.g. "utf-8" */ public abstract String getEncoding(); /** * The MIME type of the rendered content sent to the client. * - * @return The mime type of the data written to the writer, e.g. - * "text/plain" + * @return The mime type of the data written to the writer, e.g. "text/plain" */ public abstract String getMimeType(); |