org.jboss.resteasy.plugins.providers.html
Class HtmlRenderableWriter

java.lang.Object
  org.jboss.resteasy.plugins.providers.html.HtmlRenderableWriter

All Implemented Interfaces:

MessageBodyWriter<Renderable>

@Provider
public class HtmlRenderableWriter
extends java.lang.Object
implements MessageBodyWriter<Renderable>

Author:

Jeff Schnitzer

Constructor Summary

HtmlRenderableWriter()

Method Summary

long	getSize(Renderable obj, java.lang.Class type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType) Called before writeTo to ascertain the length in bytes of the serialized form of t.
boolean	isWriteable(java.lang.Class type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType) Ascertain if the MessageBodyWriter supports a particular type.
void	writeTo(Renderable viewingPleasure, java.lang.Class type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType, MultivaluedMap httpHeaders, java.io.OutputStream entityStream) Write a type to an HTTP response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlRenderableWriter

public HtmlRenderableWriter()

Method Detail

getSize

public long getSize(Renderable obj,
                    java.lang.Class type,
                    java.lang.reflect.Type genericType,
                    java.lang.annotation.Annotation[] annotations,
                    MediaType mediaType)

Description copied from interface: MessageBodyWriter

Called before writeTo to ascertain the length in bytes of the serialized form of t. A non-negative return value is used in a HTTP Content-Length header.

Specified by:

getSize in interface MessageBodyWriter<Renderable>

Parameters:

obj - the instance to write

type - the class of object that is to be written.

genericType - the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.

annotations - an array of the annotations on the resource method that returns the object.

mediaType - the media type of the HTTP entity.

Returns:

length in bytes or -1 if the length cannot be determined in advance

isWriteable

public boolean isWriteable(java.lang.Class type,
                           java.lang.reflect.Type genericType,
                           java.lang.annotation.Annotation[] annotations,
                           MediaType mediaType)

Description copied from interface: MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

Specified by:

isWriteable in interface MessageBodyWriter<Renderable>

Parameters:

type - the class of object that is to be written.

genericType - the type of object to be written, obtained either by reflection of a resource method return type or via inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.

annotations - an array of the annotations on the resource method that returns the object.

mediaType - the media type of the HTTP entity.

Returns:

true if the type is supported, otherwise false.

writeTo

public void writeTo(Renderable viewingPleasure,
                    java.lang.Class type,
                    java.lang.reflect.Type genericType,
                    java.lang.annotation.Annotation[] annotations,
                    MediaType mediaType,
                    MultivaluedMap httpHeaders,
                    java.io.OutputStream entityStream)
             throws java.io.IOException,
                    WebApplicationException

Description copied from interface: MessageBodyWriter

Write a type to an HTTP response. The response header map is mutable but any changes must be made before writing to the output stream since the headers will be flushed prior to writing the response body.

Specified by:

writeTo in interface MessageBodyWriter<Renderable>

Parameters:

viewingPleasure - the instance to write.

type - the class of object that is to be written.

genericType - the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.

annotations - an array of the annotations on the resource method that returns the object.

mediaType - the media type of the HTTP entity.

httpHeaders - a mutable map of the HTTP response headers.

entityStream - the OutputStream for the HTTP entity. The implementation should not close the output stream.

Throws:

java.io.IOException - if an IO error arises

WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response being committed.