fix javadoc and simplify accepts/type on Renderer

jknack · jknack · commit 41d2619e735d · 2015-05-22T12:17:08.000-03:00
diff --git a/coverage-report/src/test/java/org/jooby/BodyConverters.java b/coverage-report/src/test/java/org/jooby/BodyConverters.java
@@ -6,14 +6,14 @@ public class BodyConverters {
 
   public static final Renderer toJson = (body, ctx) -> {
     if (ctx.accepts("json")) {
-      ctx.type(MediaType.json)
+      ctx.type("json")
           .send("{\"body\": \"" + body + "\"}");
     }
   };
 
   public static final Renderer toHtml = (viewable, ctx) -> {
     if (ctx.accepts("html")) {
-      ctx.type(MediaType.html)
+      ctx.type("html")
           .send("<html><body>" + viewable + "</body></html>");
     }
   };
diff --git a/coverage-report/src/test/java/org/jooby/jackson/JsonCustomTypeFeature.java b/coverage-report/src/test/java/org/jooby/jackson/JsonCustomTypeFeature.java
@@ -18,7 +18,7 @@ public class JsonCustomTypeFeature extends ServerFeature {
 
   {
 
-    use(new Jackson().types(MediaType.valueOf("application/vnd.github.v3+json")));
+    use(new Jackson().type(MediaType.valueOf("application/vnd.github.v3+json")));
 
     get("/members",
         req -> Lists.newArrayList(ImmutableMap.<String, Object> of("id", 1, "name", "pablo")));
diff --git a/jooby-jackson/src/main/java/org/jooby/json/Jackson.java b/jooby-jackson/src/main/java/org/jooby/json/Jackson.java
@@ -23,7 +23,6 @@
 
 import java.text.SimpleDateFormat;
 import java.util.LinkedHashSet;
-import java.util.List;
 import java.util.Locale;
 import java.util.Set;
 import java.util.TimeZone;
@@ -41,7 +40,6 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import com.fasterxml.jackson.datatype.jsr310.JSR310Module;
-import com.google.common.collect.ImmutableList;
 import com.google.inject.Binder;
 import com.google.inject.Key;
 import com.google.inject.multibindings.Multibinder;
@@ -132,7 +130,7 @@ public PostConfigurer(final ObjectMapper mapper, final Set<Module> jacksonModule
 
   private final Set<Module> modules = new LinkedHashSet<>();
 
-  private List<MediaType> types = ImmutableList.of(MediaType.json);
+  private MediaType type = MediaType.json;
 
   public Jackson(final ObjectMapper mapper) {
     this.mapper = checkNotNull(mapper, "An object mapper is required.");
@@ -145,17 +143,13 @@ public Jackson() {
     this(new ObjectMapper());
   }
 
-  public Jackson types(final MediaType... types) {
-    return types(ImmutableList.copyOf(types));
-  }
-
-  public Jackson types(final List<MediaType> types) {
-    this.types = ImmutableList.copyOf(types);
+  public Jackson type(final MediaType type) {
+    this.type = type;
     return this;
   }
 
-  public Jackson types(final String... types) {
-    return types(MediaType.valueOf(types));
+  public Jackson types(final String type) {
+    return type(MediaType.valueOf(type));
   }
 
   public Jackson doWith(final Consumer<ObjectMapper> block) {
@@ -181,8 +175,8 @@ public void configure(final Env mode, final Config config, final Binder binder)
     binder.bind(PostConfigurer.class).asEagerSingleton();
 
     // json parser & renderer
-    JacksonParser parser = new JacksonParser(mapper, types);
-    JacksonRenderer renderer = new JacksonRenderer(mapper, types);
+    JacksonParser parser = new JacksonParser(mapper, type);
+    JacksonRenderer renderer = new JacksonRenderer(mapper, type);
 
     Multibinder.newSetBinder(binder, Renderer.class)
         .addBinding()
diff --git a/jooby-jackson/src/main/java/org/jooby/json/JacksonParser.java b/jooby-jackson/src/main/java/org/jooby/json/JacksonParser.java
@@ -1,7 +1,5 @@
 package org.jooby.json;
 
-import java.util.List;
-
 import org.jooby.MediaType;
 import org.jooby.MediaType.Matcher;
 import org.jooby.Parser;
@@ -16,9 +14,9 @@ class JacksonParser implements Parser {
 
   private Matcher matcher;
 
-  public JacksonParser(final ObjectMapper mapper, final List<MediaType> types) {
+  public JacksonParser(final ObjectMapper mapper, final MediaType type) {
     this.mapper = mapper;
-    this.matcher = MediaType.matcher(types);
+    this.matcher = MediaType.matcher(type);
   }
 
   @Override
diff --git a/jooby-jackson/src/main/java/org/jooby/json/JacksonRenderer.java b/jooby-jackson/src/main/java/org/jooby/json/JacksonRenderer.java
@@ -1,7 +1,5 @@
 package org.jooby.json;
 
-import java.util.List;
-
 import org.jooby.MediaType;
 import org.jooby.Renderer;
 
@@ -11,17 +9,17 @@ class JacksonRenderer implements Renderer {
 
   private ObjectMapper mapper;
 
-  private List<MediaType> types;
+  private MediaType type;
 
-  public JacksonRenderer(final ObjectMapper mapper, final List<MediaType> types) {
+  public JacksonRenderer(final ObjectMapper mapper, final MediaType type) {
     this.mapper = mapper;
-    this.types = types;
+    this.type = type;
   }
 
   @Override
   public void render(final Object value, final Context ctx) throws Exception {
-    if (ctx.accepts(types) && mapper.canSerialize(value.getClass())) {
-      ctx.type(types.get(0));
+    if (ctx.accepts(type) && mapper.canSerialize(value.getClass())) {
+      ctx.type(type);
       // use UTF-8 and get byte version
       byte[] bytes = mapper.writer().writeValueAsBytes(value);
       ctx.length(bytes.length)
diff --git a/jooby/src/main/java/org/jooby/Err.java b/jooby/src/main/java/org/jooby/Err.java
@@ -42,9 +42,8 @@
 public class Err extends RuntimeException {
 
   /**
-   * Default err handler it does content negotation. On
-   * <code>text/html<code> requests the err handler
-   * creates an <code>err</code> view and set as model the {@link Err#toMap()}.
+   * Default err handler it does content negotation. On <code>text/html</code> requests the err
+   * handler creates an <code>err</code> view and set as model the {@link Err#toMap()}.
    *
    * @author edgar
    * @since 0.1.0
diff --git a/jooby/src/main/java/org/jooby/Renderer.java b/jooby/src/main/java/org/jooby/Renderer.java
@@ -24,11 +24,8 @@
 import java.nio.CharBuffer;
 import java.nio.channels.FileChannel;
 import java.nio.charset.Charset;
-import java.util.List;
 import java.util.Map;
 
-import com.google.common.collect.ImmutableList;
-
 /**
  * Write a value into the HTTP response and apply a format, if need it.
  *
@@ -97,11 +94,13 @@ public interface Renderer {
   interface Context {
 
     /**
-     * @return Request attributes.
+     * @return Request local attributes.
      */
     Map<String, Object> locals();
 
     /**
+     * True if the given type matches the <code>Accept</code> header.
+     *
      * @param type The type to check for.
      * @return True if the given type matches the <code>Accept</code> header.
      */
@@ -110,18 +109,23 @@ default boolean accepts(final String type) {
     }
 
     /**
+     * True if the given type matches the <code>Accept</code> header.
+     *
      * @param type The type to check for.
      * @return True if the given type matches the <code>Accept</code> header.
      */
-    default boolean accepts(final MediaType type) {
-      return accepts(ImmutableList.of(type));
-    }
+    boolean accepts(final MediaType type);
 
     /**
-     * @param types Types to check for.
-     * @return True if the given type matches the <code>Accept</code> header.
+     * Set the <code>Content-Type</code> header IF and ONLY IF, no <code>Content-Type</code> was set
+     * yet.
+     *
+     * @param type A suggested type to use if one is missing.
+     * @return This context.
      */
-    boolean accepts(List<MediaType> types);
+    default Context type(final String type) {
+      return type(MediaType.valueOf(type));
+    }
 
     /**
      * Set the <code>Content-Type</code> header IF and ONLY IF, no <code>Content-Type</code> was set
@@ -147,57 +151,86 @@ default boolean accepts(final MediaType type) {
     Charset charset();
 
     /**
-     * Write bytes into the HTTP response body and close the resources.
+     * Write bytes into the HTTP response body.
+     *
+     * It will set a <code>Content-Length</code> if none was set
+     * It will set a <code>Content-Type</code> to {@link MediaType#octetstream} if none was set.
      *
      * @param bytes A bytes to write.
      * @throws Exception When the operation fails.
      */
     void send(byte[] bytes) throws Exception;
 
     /**
-     * Write bytes into the HTTP response body and close the resources.
+     * Write byte buffer into the HTTP response body.
      *
-     * @param bytes A bytes to write.
+     * It will set a <code>Content-Length</code> if none was set.
+     * It will set a <code>Content-Type</code> to {@link MediaType#octetstream} if none was set.
+     *
+     * @param buffer A buffer to write.
      * @throws Exception When the operation fails.
      */
     void send(ByteBuffer buffer) throws Exception;
 
     /**
-     * Write test into the HTTP response body.
+     * Write text into the HTTP response body.
      *
-     * @param data A text to write.
+     * It will set a <code>Content-Length</code> if none was set.
+     * It will set a <code>Content-Type</code> to {@link MediaType#html} if none was set.
+     *
+     * @param text A text to write.
      * @throws Exception When the operation fails.
      */
     void send(String text) throws Exception;
 
     /**
-     * Write test into the HTTP response body.
+     * Write bytes into the HTTP response body.
      *
-     * @param text A text to write.
+     * It will set a <code>Content-Length</code> if the response size is less than the
+     * <code>server.ResponseBufferSize</code> (default is: 16k). If the response is larger than the
+     * buffer size, it will set a <code>Transfer-Encoding: chunked</code> header.
+     *
+     * It will set a <code>Content-Type</code> to {@link MediaType#octetstream} if none was set.
+     *
+     * This method will check if the given input stream has a {@link FileChannel} and redirect to file
+     *
+     * @param stream Bytes to write.
      * @throws Exception When the operation fails.
      */
     void send(InputStream stream) throws Exception;
 
     /**
-     * Write test into the HTTP response body.
+     * Write text into the HTTP response body.
      *
-     * @param text A text to write.
+     * It will set a <code>Content-Length</code> if none was set.
+     * It will set a <code>Content-Type</code> to {@link MediaType#html} if none was set.
+     *
+     * @param buffer A text to write.
      * @throws Exception When the operation fails.
      */
     void send(CharBuffer buffer) throws Exception;
 
     /**
-     * Write test into the HTTP response body.
+     * Write text into the HTTP response body.
      *
-     * @param text A text to write.
+     * It will set a <code>Content-Length</code> if the response size is less than the
+     * <code>server.ResponseBufferSize</code> (default is: 16k). If the response is larger than the
+     * buffer size, it will set a <code>Transfer-Encoding: chunked</code> header.
+     *
+     * It will set a <code>Content-Type</code> to {@link MediaType#html} if none was set.
+     *
+     * @param reader Text to write.
      * @throws Exception When the operation fails.
      */
     void send(Reader reader) throws Exception;
 
     /**
-     * Write test into the HTTP response body.
+     * Write file into the HTTP response body, using OS zero-copy transfer (if possible).
      *
-     * @param text A text to write.
+     * It will set a <code>Content-Length</code> if none was set.
+     * It will set a <code>Content-Type</code> to {@link MediaType#html} if none was set.
+     *
+     * @param file A text to write.
      * @throws Exception When the operation fails.
      */
     void send(FileChannel file) throws Exception;
diff --git a/jooby/src/main/java/org/jooby/internal/AbstractRendererContext.java b/jooby/src/main/java/org/jooby/internal/AbstractRendererContext.java
@@ -18,7 +18,6 @@
 import org.jooby.MediaType;
 import org.jooby.MediaType.Matcher;
 import org.jooby.Renderer;
-import org.jooby.Renderer.Context;
 import org.jooby.Status;
 import org.jooby.View;
 
@@ -78,18 +77,18 @@ public Map<String, Object> locals() {
   }
 
   @Override
-  public boolean accepts(final List<MediaType> types) {
-    return matcher.matches(types);
+  public boolean accepts(final MediaType type) {
+    return matcher.matches(type);
   }
 
   @Override
-  public Context type(final MediaType type) {
+  public Renderer.Context type(final MediaType type) {
     // NOOP
     return this;
   }
 
   @Override
-  public Context length(final long length) {
+  public Renderer.Context length(final long length) {
     // NOOP
     return this;
   }
@@ -101,45 +100,52 @@ public Charset charset() {
 
   @Override
   public void send(final CharBuffer buffer) throws Exception {
+    type(MediaType.html);
     send(charset.encode(buffer));
   }
 
   @Override
   public void send(final Reader reader) throws Exception {
+    type(MediaType.html);
     send(new ReaderInputStream(reader, charset));
   }
 
   @Override
   public void send(final String text) throws Exception {
+    type(MediaType.html);
     _send(text);
     committed = true;
   }
 
   @Override
   public void send(final byte[] bytes) throws Exception {
+    type(MediaType.octetstream);
     length(bytes.length);
     _send(bytes);
     committed = true;
   }
 
   @Override
   public void send(final ByteBuffer buffer) throws Exception {
+    type(MediaType.octetstream);
     length(buffer.remaining());
     _send(buffer);
     committed = true;
   }
 
   @Override
   public void send(final FileChannel file) throws Exception {
+    type(MediaType.octetstream);
     length(file.size());
     _send(file);
     committed = true;
   }
 
   @Override
   public void send(final InputStream stream) throws Exception {
+    type(MediaType.octetstream);
     if (stream instanceof FileInputStream) {
-      _send(((FileInputStream) stream).getChannel());
+      send(((FileInputStream) stream).getChannel());
     } else {
       _send(stream);
     }

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class JsonCustomTypeFeature extends ServerFeature {`
`18`	`18`
`19`	`19`	`{`
`20`	`20`
`21`		`- use(new Jackson().types(MediaType.valueOf("application/vnd.github.v3+json")));`
	`21`	`+ use(new Jackson().type(MediaType.valueOf("application/vnd.github.v3+json")));`
`22`	`22`
`23`	`23`	`get("/members",`
`24`	`24`	`req -> Lists.newArrayList(ImmutableMap.<String, Object> of("id", 1, "name", "pablo")));`