Spec-Zone .ru спецификации, руководства, описания, API

javax.ws.rs.ext
Соедините интерфейсом с MessageBodyWriter <T>

public interface MessageBodyWriter<T>

Контракт для провайдера, который поддерживает преобразование типа Java к потоку. Добавить a MessageBodyWriter реализация, аннотируйте реализацию class @Provider. A MessageBodyWriter реализация может быть аннотирована Produces ограничить типы носителей, для которых это будут считать подходящим.

См. Также:

Provider, Produces

Сводка метода

long	getSize(T t, java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType) Вызванный прежде writeTo установить длину в байтах сериализированной формы t.
boolean	isWriteable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType) Установите, поддерживает ли MessageBodyWriter определенный тип.
void	writeTo(T t, 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) Запишите тип в ответ HTTP.

Деталь метода

isWriteable

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

Установите, поддерживает ли MessageBodyWriter определенный тип.

Параметры:

type - class объекта, который должен быть записан.

genericType - тип объекта, который будет записан, полученный или отражением типа возврата метода ресурса или через контроль возвращенного экземпляра. GenericEntity обеспечивает способ определить эту информацию во времени выполнения.

annotations - массив аннотаций на метод ресурса, который возвращает объект.

mediaType - тип носителей объекта HTTP.

Возвраты:

истина, если тип поддерживается, иначе ложь.

getSize

long getSize(T t,
             java.lang.Class<?> type,
             java.lang.reflect.Type genericType,
             java.lang.annotation.Annotation[] annotations,
             MediaType mediaType)

Вызванный прежде writeTo установить длину в байтах сериализированной формы t. Неотрицательное возвращаемое значение используется в HTTP Content-Length заголовок.

Параметры:

t - экземпляр, чтобы записать

type - class объекта, который должен быть записан.

genericType - тип объекта, который будет записан, полученный или отражением типа возврата метода ресурса или контролем возвращенного экземпляра. GenericEntity обеспечивает способ определить эту информацию во времени выполнения.

annotations - массив аннотаций на метод ресурса, который возвращает объект.

mediaType - тип носителей объекта HTTP.

Возвраты:

длина в байтах или-1, если длина не может быть определена заранее

writeTo

void writeTo(T t,
             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

Запишите тип в ответ HTTP. Карта заголовка ответа изменчива, но любые изменения должны быть произведены прежде, чем записать в поток вывода, так как заголовки будут сброшены до записи тела ответа.

Параметры:

t - экземпляр, чтобы записать.

type - class объекта, который должен быть записан.

genericType - тип объекта, который будет записан, полученный или отражением типа возврата метода ресурса или контролем возвращенного экземпляра. GenericEntity обеспечивает способ определить эту информацию во времени выполнения.

annotations - массив аннотаций на метод ресурса, который возвращает объект.

mediaType - тип носителей объекта HTTP.

httpHeaders - изменчивая карта заголовков ответа HTTP.

entityStream - OutputStream для объекта HTTP. Реализация не должна закрыть поток вывода.

Броски:

java.io.IOException - если ошибка IO возникает

WebApplicationException - если определенный ошибочный ответ HTTP должен быть произведен. Только эффективный если брошено до фиксировавшего ответа.