io.jooby

Interface MessageEncoder

All Known Subinterfaces:

TemplateEngine

All Known Implementing Classes:

HttpMessageEncoder

public interface MessageEncoder

Render a route output as byte array.

Since:

2.0.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static MessageEncoder	TO_STRING To string renderer.

Method Summary

Modifier and Type	Method and Description
default MessageEncoder	accept(MediaType contentType) Execute this renderer only if the Accept header matches the content-type parameter.
byte[]	encode(Context ctx, Object value) MessageEncoder a value into a byte array or null if given object isn't supported it.

Field Detail

TO_STRING

static final MessageEncoder TO_STRING

To string renderer.

Method Detail

encode

@Nonnull
byte[] encode(@Nonnull
                       Context ctx,
                       @Nonnull
                       Object value)
                throws Exception

MessageEncoder a value into a byte array or null if given object isn't supported it.

Parameters:

ctx - Web context.

value - Value to render.

Returns:

Value as byte array or null if given object isn't supported it.

Throws:

Exception - If something goes wrong.

accept

@Nonnull
default MessageEncoder accept(@Nonnull
                                       MediaType contentType)

Execute this renderer only if the Accept header matches the content-type parameter.

Parameters:

contentType - Mediatype to test.

Returns:

A new renderer with accept header matching.