| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MessageBodyReader</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MessageBodyReader"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/ws/rs/ext/InterceptorContext.html" title="interface in jakarta.ws.rs.ext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/ext/MessageBodyReader.html" target="_top">Frames</a></li> |
| <li><a href="MessageBodyReader.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.ws.rs.ext</div> |
| <h2 title="Interface MessageBodyReader" class="title">Interface MessageBodyReader<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Java type supported by the provider</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">MessageBodyReader<T></span></pre> |
| <div class="block">Contract for a provider that supports the conversion of a stream to a Java type. |
| |
| A <code>MessageBodyReader</code> implementation may be annotated with <a href="../../../../jakarta/ws/rs/Consumes.html" title="annotation in jakarta.ws.rs"><code>Consumes</code></a> to restrict the media |
| types for which it will be considered suitable. The <code>MessageBodyReader</code> pipeline is executed if the matching |
| resource method declares an entity parameter or uses at least one <a href="../../../../jakarta/ws/rs/FormParam.html" title="annotation in jakarta.ws.rs"><code>FormParam</code></a>. |
| <p> |
| Providers implementing <code>MessageBodyReader</code> contract must be either programmatically registered in a JAX-RS |
| runtime or must be annotated with <a href="../../../../jakarta/ws/rs/ext/Provider.html" title="annotation in jakarta.ws.rs.ext"><code>@Provider</code></a> annotation to be automatically |
| discovered by the JAX-RS runtime during a provider scanning phase. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/ws/rs/ext/Provider.html" title="annotation in jakarta.ws.rs.ext"><code>Provider</code></a>, |
| <a href="../../../../jakarta/ws/rs/Consumes.html" title="annotation in jakarta.ws.rs"><code>Consumes</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html#isReadable-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-">isReadable</a></span>(java.lang.Class<?> type, |
| java.lang.reflect.Type genericType, |
| java.lang.annotation.Annotation[] annotations, |
| <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a> mediaType)</code> |
| <div class="block">Ascertain if the MessageBodyReader can produce an instance of a particular type.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="type parameter in MessageBodyReader">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html#readFrom-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-jakarta.ws.rs.core.MultivaluedMap-java.io.InputStream-">readFrom</a></span>(java.lang.Class<<a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="type parameter in MessageBodyReader">T</a>> type, |
| java.lang.reflect.Type genericType, |
| java.lang.annotation.Annotation[] annotations, |
| <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a> mediaType, |
| <a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.String> httpHeaders, |
| java.io.InputStream entityStream)</code> |
| <div class="block">Read a type from the <code>InputStream</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isReadable-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadable</h4> |
| <pre>boolean isReadable(java.lang.Class<?> type, |
| java.lang.reflect.Type genericType, |
| java.lang.annotation.Annotation[] annotations, |
| <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a> mediaType)</pre> |
| <div class="block">Ascertain if the MessageBodyReader can produce an instance of a particular type. The <code>type</code> parameter gives the |
| class of the instance that should be produced, the <code>genericType</code> parameter gives the |
| <code>java.lang.reflect.Type</code> of the instance that should be produced. E.g. if the instance |
| to be produced is <code>List<String></code>, the <code>type</code> parameter will be <code>java.util.List</code> and the |
| <code>genericType</code> parameter will be <code>java.lang.reflect.ParameterizedType</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the class of instance to be produced.</dd> |
| <dd><code>genericType</code> - the type of instance 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 |
| <code>Method.getGenericParameterTypes</code>.</dd> |
| <dd><code>annotations</code> - 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 <code>Method.getParameterAnnotations</code>.</dd> |
| <dd><code>mediaType</code> - the media type of the HTTP entity, if one is not specified in the request then |
| <code>application/octet-stream</code> is used.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the type is supported, otherwise <code>false</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readFrom-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-jakarta.ws.rs.core.MultivaluedMap-java.io.InputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>readFrom</h4> |
| <pre><a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="type parameter in MessageBodyReader">T</a> readFrom(java.lang.Class<<a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="type parameter in MessageBodyReader">T</a>> type, |
| java.lang.reflect.Type genericType, |
| java.lang.annotation.Annotation[] annotations, |
| <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a> mediaType, |
| <a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.String> httpHeaders, |
| java.io.InputStream entityStream) |
| throws java.io.IOException, |
| <a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></pre> |
| <div class="block">Read a type from the <code>InputStream</code>. |
| <p> |
| In case the entity input stream is empty, the reader is expected to either return a Java representation of a |
| zero-length entity or throw a <a href="../../../../jakarta/ws/rs/core/NoContentException.html" title="class in jakarta.ws.rs.core"><code>NoContentException</code></a> in case no zero-length entity |
| representation is defined for the supported Java type. A <code>NoContentException</code>, if thrown by a message body |
| reader while reading a server request entity, is automatically translated by JAX-RS server runtime into a |
| <a href="../../../../jakarta/ws/rs/BadRequestException.html" title="class in jakarta.ws.rs"><code>BadRequestException</code></a> wrapping the original <code>NoContentException</code> and rethrown for a standard |
| processing by the registered <a href="../../../../jakarta/ws/rs/ext/ExceptionMapper.html" title="interface in jakarta.ws.rs.ext"><code>exception mappers</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type that is to be read from the entity stream.</dd> |
| <dd><code>genericType</code> - the type of instance 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 |
| <code>Method.getGenericParameterTypes</code>.</dd> |
| <dd><code>annotations</code> - 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 <code>Method.getParameterAnnotations</code>.</dd> |
| <dd><code>mediaType</code> - the media type of the HTTP entity.</dd> |
| <dd><code>httpHeaders</code> - the read-only HTTP headers associated with HTTP entity.</dd> |
| <dd><code>entityStream</code> - the <code>InputStream</code> of the HTTP entity. The caller is responsible for ensuring that the input |
| stream ends when the entity has been consumed. The implementation should not close the input stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the type that was read from the stream. In case the entity input stream is empty, the reader is expected to |
| either return an instance representing a zero-length entity or throw a <a href="../../../../jakarta/ws/rs/core/NoContentException.html" title="class in jakarta.ws.rs.core"><code>NoContentException</code></a> in |
| case no zero-length entity representation is defined for the supported Java type.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if an IO error arises. In case the entity input stream is empty and the reader is not |
| able to produce a Java representation for a zero-length entity, <code>NoContentException</code> is expected to be thrown.</dd> |
| <dd><code><a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></code> - if a specific HTTP error response needs to be produced. Only effective if |
| thrown prior to the response being committed.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/ws/rs/ext/InterceptorContext.html" title="interface in jakarta.ws.rs.ext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/ext/MessageBodyReader.html" target="_top">Frames</a></li> |
| <li><a href="MessageBodyReader.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
