ratpack.render.Renderer Maven / Gradle / Ivy
/*
* Copyright 2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ratpack.render;
import ratpack.api.NonBlocking;
import ratpack.api.Nullable;
import ratpack.handling.Context;
/**
* A renderer is responsible for rendering an object to the response.
*
* Renderers are typically not used directly.
* Instead, they are used via by {@link Context#render(Object)} method.
*
* See {@link ratpack.render.RendererSupport} for support base class for implementations.
*
* @see ratpack.render.RendererSupport
* @param The type of object that this renderer knows how to render.
*/
public interface Renderer {
/**
* The type of object that this renderer can render.
*
* @return The type of object that this renderer can render.
*/
@Nullable
Class getType();
/**
* 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 {@link Context#error(Exception)}.
*
* @param context the context for the operation
* @param object the object to render
* @throws Exception if anything goes wrong while rendering
*/
@NonBlocking
void render(Context context, T object) throws Exception;
}