org.jooby

Interface Renderer

All Known Subinterfaces:

View.Engine

All Known Implementing Classes:

YassonRawRenderer, YassonRenderer

public interface Renderer

Write a value into the HTTP response and apply a format, if need it. Renderers are executed in the order they were registered. The first renderer that write a response wins! There are two ways of registering a rendering:

 {
   renderer((value, ctx)  -> {
     ...
   });
 }
 

Or from inside a module:

 {
   use((env, conf, binder)  -> {
     Multibinder.newSetBinder(binder, Renderer.class)
        .addBinding()
        .toInstance((value, ctx)  -> {
          ...
        }));
   });
 }
 

Inside a Renderer you can do whatever you want. For example you can check for a specific type:

   renderer((value, ctx)  -> {
     if (value instanceof MyObject) {
       ctx.send(value.toString());
     }
   });
 

Or check for the Accept header:

   renderer((value, ctx)  -> {
     if (ctx.accepts("json")) {
       ctx.send(toJson(value));
     }
   });
 

API is simple and powerful!

Since:

0.6.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Renderer.Context Contains a few utility methods for doing the actual rendering and writing.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.inject.Key<Set<Renderer>>	KEY Renderer key.

Method Summary

Modifier and Type	Method and Description
default String	name()
static Renderer	of(String name, Renderer renderer) Renderer factory method.
void	render(Object value, Renderer.Context ctx) Render the given value and write the response (if possible).

Field Detail

KEY

static final com.google.inject.Key<Set<Renderer>> KEY

Renderer key.

Method Detail

name

default String name()

Returns:

Renderer's name.

render

void render(Object value,
            Renderer.Context ctx)
     throws Exception

Render the given value and write the response (if possible). If no response is written, the next renderer in the chain will be invoked.

Parameters:

value - Object to render.

ctx - Rendering context.

Throws:

Exception - If rendering fails.

of

static Renderer of(String name,
                   Renderer renderer)

Renderer factory method.

Parameters:

name - Renderer's name.

renderer - Renderer's function.

Returns:

A new renderer.