org.jboss.resteasy.plugins.providers.multipart
Class MultipartRelatedWriter
java.lang.Object
org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter
org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartRelatedWriter
org.jboss.resteasy.plugins.providers.multipart.MultipartRelatedWriter
- All Implemented Interfaces:
- MessageBodyWriter<MultipartRelatedOutput>
@Provider
public class MultipartRelatedWriter
- extends AbstractMultipartRelatedWriter
- implements MessageBodyWriter<MultipartRelatedOutput>
The MessageBodyWriter
implementation to serialize
MultipartRelatedOutput
objects.
- Version:
- $Revision: 1 $
- Author:
- Attila Kiraly
Method Summary |
long |
getSize(MultipartRelatedOutput multipartRelatedOutput,
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(MultipartRelatedOutput multipartRelatedOutput,
java.lang.Class<?> type,
java.lang.reflect.Type genericType,
java.lang.annotation.Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<java.lang.String,java.lang.Object> 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 |
MultipartRelatedWriter
public MultipartRelatedWriter()
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<MultipartRelatedOutput>
- 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.
getSize
public long getSize(MultipartRelatedOutput multipartRelatedOutput,
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<MultipartRelatedOutput>
- Parameters:
multipartRelatedOutput
- the instance to writetype
- 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
writeTo
public void writeTo(MultipartRelatedOutput multipartRelatedOutput,
java.lang.Class<?> type,
java.lang.reflect.Type genericType,
java.lang.annotation.Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<java.lang.String,java.lang.Object> 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<MultipartRelatedOutput>
- Parameters:
multipartRelatedOutput
- 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.
Copyright © 2010. All Rights Reserved.