Package ratpack.core.render
Interface Renderer<T>
-
- Type Parameters:
T
- The type of object that this renderer knows how to render.
- All Known Subinterfaces:
RockerRenderer
- All Known Implementing Classes:
GroovyRendererSupport
,RendererSupport
public interface Renderer<T>
A renderer is responsible for rendering an object to the response.Renderers are typically not used directly. Instead, they are used via by
Context.render(Object)
method.See
RendererSupport
for support base class for implementations.An alternative to implementing a renderer for a type is to make the type directly implement
Renderable
.- See Also:
RendererSupport
,RenderableDecorator
,Renderable
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description Class<T>
getType()
The type of object that this renderer can render.static <T> Renderer<T>
of(Class<T> type, BiConsumer<? super Context,? super T> impl)
Creates a renderer implementation from the given arguments.void
render(Context context, T object)
Render the given object to the response.static <T> com.google.common.reflect.TypeToken<Renderer<T>>
typeOf(Class<T> typeToRender)
Creates a type token for a renderer of the given type of object.
-
-
-
Method Detail
-
of
static <T> Renderer<T> of(Class<T> type, BiConsumer<? super Context,? super T> impl)
Creates a renderer implementation from the given arguments.- Type Parameters:
T
- the type of object-to-render- Parameters:
type
- the type of object-to-renderimpl
- the implementation of therender(Context, Object)
method- Returns:
- a renderer implementation
-
typeOf
static <T> com.google.common.reflect.TypeToken<Renderer<T>> typeOf(Class<T> typeToRender)
Creates a type token for a renderer of the given type of object.- Type Parameters:
T
- the type that the renderer renders- Parameters:
typeToRender
- the type that the renderer renders- Returns:
- a type token for a renderer of the given type of object
-
getType
Class<T> getType()
The type of object that this renderer can render.- Returns:
- The type of object that this renderer can render.
-
render
@NonBlocking void render(Context context, T object) throws Exception
Render the given object to the response.Calling this method will finalize the processing, sending the response to the client.
Any errors that occur during rendering will be sent to
Context.error(Throwable)
.- Parameters:
context
- the context for the operationobject
- the object to render- Throws:
Exception
- if anything goes wrong while rendering
-
-