|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageBodyWorkers
An injectable interface providing lookup of MessageBodyReader
and
MessageBodyWriter
instances.
Context
,
MessageBodyReader
,
MessageBodyWriter
Method Summary | ||
---|---|---|
|
getMessageBodyReader(Class<T> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType)
Get a message body reader that matches a set of criteria. |
|
|
getMessageBodyWriter(Class<T> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType)
Get a message body writer that matches a set of criteria. |
|
|
getMessageBodyWriterMediaType(Class<T> type,
Type genericType,
Annotation[] annotations,
List<javax.ws.rs.core.MediaType> acceptableMediaTypes)
Get the most acceptable media type supported for a Java type given a set of acceptable media types. |
|
|
getMessageBodyWriterMediaTypes(Class<T> type,
Type genericType,
Annotation[] annotations)
Get the list of media types supported for a Java type. |
|
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> |
getReaders(javax.ws.rs.core.MediaType mediaType)
Get the map of media type to list of message body writers that are compatible with a media type. |
|
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> |
getWriters(javax.ws.rs.core.MediaType mediaType)
Get the map of media type to list of message body writers that are compatible with a media type. |
|
String |
readersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> readers)
Convert a map media type to list of message body readers to a string. |
|
String |
writersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> writers)
Convert a map media type to list of message body writers to a string. |
Method Detail |
---|
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> getReaders(javax.ws.rs.core.MediaType mediaType)
mediaType
- the compatible media type.
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> getWriters(javax.ws.rs.core.MediaType mediaType)
mediaType
- the compatible media type.
String readersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> readers)
readers
- the map media type to list of message body readers
String writersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> writers)
writers
- the map media type to list of message body readers
<T> javax.ws.rs.ext.MessageBodyReader<T> getMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
T
- the type of object to be read.mediaType
- the media type of the data that will be read, this will
be compared to the values of Consumes
for
each candidate reader and only matching readers will be queried.type
- the class of object to be read.genericType
- the type of object to be produced. E.g. if the
message body is to be converted into a method parameter, this will be
the formal type of the method parameter as returned by
Class.getGenericParameterTypes
.annotations
- an array of the annotations on the declaration of the
artifact that will be initialized with the produced instance. E.g. if the
message body is to be converted into a method parameter, this will be
the annotations on that parameter returned by
Class.getParameterAnnotations
.
<T> javax.ws.rs.ext.MessageBodyWriter<T> getMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
T
- the type of the object that is to be written.mediaType
- the media type of the data that will be written, this will
be compared to the values of Produces
for
each candidate writer and only matching writers will be queried.type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the
message body is to be produced from a field, this will be
the declared type of the field as returned by
Field.getGenericType
.annotations
- an array of the annotations on the declaration of the
artifact that will be written. E.g. if the
message body is to be produced from a field, this will be
the annotations on that field returned by
Field.getDeclaredAnnotations
.
<T> List<javax.ws.rs.core.MediaType> getMessageBodyWriterMediaTypes(Class<T> type, Type genericType, Annotation[] annotations)
T
- the type of object that is to be written.type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the
message body is to be produced from a field, this will be
the declared type of the field as returned by
Field.getGenericType
.annotations
- an array of the annotations on the declaration of the
artifact that will be written. E.g. if the
message body is to be produced from a field, this will be
the annotations on that field returned by
Field.getDeclaredAnnotations
.
<T> javax.ws.rs.core.MediaType getMessageBodyWriterMediaType(Class<T> type, Type genericType, Annotation[] annotations, List<javax.ws.rs.core.MediaType> acceptableMediaTypes)
T
- the type of object that is to be written.type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the
message body is to be produced from a field, this will be
the declared type of the field as returned by
Field.getGenericType
.annotations
- an array of the annotations on the declaration of the
artifact that will be written. E.g. if the
message body is to be produced from a field, this will be
the annotations on that field returned by
Field.getDeclaredAnnotations
.acceptableMediaTypes
- the list of acceptable media types, sorted
according to the quality with the media type of highest quality
occurring first first.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |