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

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

public interface MessageBodyReader<T>

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

См. Также:

Provider, Consumes

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

boolean	isReadable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType) Установите, может ли MessageBodyReader произвести экземпляр определенного типа.
T	readFrom(java.lang.Class<T> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType, MultivaluedMap<java.lang.String,java.lang.String> httpHeaders, java.io.InputStream entityStream) Считайте тип из InputStream.

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

isReadable

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

Установите, может ли MessageBodyReader произвести экземпляр определенного типа. Параметр типа дает class объекта, который должен быть произведен, genericType параметр дает java.lang.reflect. Тип объекта, который должен быть произведен. Например, если объект, который будет произведен, будет Списком, то параметр типа будет java.util. Список и genericType параметр будут java.lang.reflect. ParameterizedType.

Параметры:

type - class объекта, который будет произведен.

genericType - тип объекта, который будет произведен. Например, если текст сообщения должен быть преобразован в параметр метода, это будет формальным типом параметра метода как возвращено Method.getGenericParameterTypes.

annotations - массив аннотаций на объявление артефакта, который будет инициализирован с произведенным экземпляром. Например, если текст сообщения должен быть преобразован в параметр метода, это будет аннотациями на тот параметр, возвращенный Method.getParameterAnnotations.

mediaType - тип носителей объекта HTTP, если Вы не определяетесь в запросе тогда application/octet-stream используется.

Возвраты:

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

readFrom

T readFrom(java.lang.Class<T> type,
           java.lang.reflect.Type genericType,
           java.lang.annotation.Annotation[] annotations,
           MediaType mediaType,
           MultivaluedMap<java.lang.String,java.lang.String> httpHeaders,
           java.io.InputStream entityStream)
           throws java.io.IOException,
                  WebApplicationException

Считайте тип из InputStream.

Параметры:

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

genericType - тип объекта, который будет произведен. Например, если текст сообщения должен быть преобразован в параметр метода, это будет формальным типом параметра метода как возвращено Method.getGenericParameterTypes.

annotations - массив аннотаций на объявление артефакта, который будет инициализирован с произведенным экземпляром. Например, если текст сообщения должен быть преобразован в параметр метода, это будет аннотациями на тот параметр, возвращенный Method.getParameterAnnotations.

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

httpHeaders - HTTP-заголовки только для чтения связались с объектом HTTP.

entityStream - InputStream из объекта HTTP. Вызывающая сторона ответственна за обеспечение, что входные концы потока, когда объект был использован. Реализация не должна закрыть входной поток.

Возвраты:

тип, который был считан из потока.

Броски:

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

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