| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MessageBodyWriter</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="MessageBodyWriter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/MessageBodyReader.html" title="interface in jakarta.ws.rs.ext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/ext/ParamConverter.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/MessageBodyWriter.html" target="_top">Frames</a></li> |
| <li><a href="MessageBodyWriter.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 MessageBodyWriter" class="title">Interface MessageBodyWriter<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> - the type that can be written.</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">MessageBodyWriter<T></span></pre> |
| <div class="block">Contract for a provider that supports the conversion of a Java type to a stream. |
| |
| A <code>MessageBodyWriter</code> implementation may be annotated with <a href="../../../../jakarta/ws/rs/Produces.html" title="annotation in jakarta.ws.rs"><code>Produces</code></a> to restrict the media |
| types for which it will be considered suitable. The <code>MessageBodyWriter</code> pipeline is only invoked if there is |
| a non-null response entity. |
| <p> |
| Providers implementing <code>MessageBodyWriter</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/Produces.html" title="annotation in jakarta.ws.rs"><code>Produces</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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>default long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html#getSize-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-">getSize</a></span>(<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="type parameter in MessageBodyWriter">T</a> t, |
| 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">Originally, the method has been called before <code>writeTo</code> to ascertain the length in bytes of the serialized form |
| of <code>t</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html#isWriteable-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-">isWriteable</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 MessageBodyWriter supports a particular type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html#writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-jakarta.ws.rs.core.MultivaluedMap-java.io.OutputStream-">writeTo</a></span>(<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="type parameter in MessageBodyWriter">T</a> t, |
| 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, |
| <a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.Object> httpHeaders, |
| java.io.OutputStream entityStream)</code> |
| <div class="block">Write a type to an HTTP message.</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="isWriteable-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>isWriteable</h4> |
| <pre>boolean isWriteable(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 MessageBodyWriter supports a particular type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the class of instance that is to be written.</dd> |
| <dd><code>genericType</code> - the type of instance to be written, obtained either by reflection of a resource method return type |
| or via inspection of the returned instance. <a href="../../../../jakarta/ws/rs/core/GenericEntity.html" title="class in jakarta.ws.rs.core"><code>GenericEntity</code></a> provides a way to specify this |
| information at runtime.</dd> |
| <dd><code>annotations</code> - an array of the annotations attached to the message entity instance.</dd> |
| <dd><code>mediaType</code> - the media type of the HTTP entity.</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="getSize-java.lang.Object-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-"> |
| <!-- --> |
| </a><a name="getSize-T-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>getSize</h4> |
| <pre>default long getSize(<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="type parameter in MessageBodyWriter">T</a> t, |
| 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">Originally, the method has been called before <code>writeTo</code> to ascertain the length in bytes of the serialized form |
| of <code>t</code>. A non-negative return value has been used in a HTTP <code>Content-Length</code> header. |
| <p> |
| As of JAX-RS 2.0, the method has been deprecated and the value returned by the method is ignored by a JAX-RS runtime. |
| All <code>MessageBodyWriter</code> implementations are advised to return <code>-1</code> from the method. Responsibility to |
| compute the actual <code>Content-Length</code> header value has been delegated to JAX-RS runtime. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>t</code> - the instance to write</dd> |
| <dd><code>type</code> - the class of instance that is to be written.</dd> |
| <dd><code>genericType</code> - the type of instance to be written. <a href="../../../../jakarta/ws/rs/core/GenericEntity.html" title="class in jakarta.ws.rs.core"><code>GenericEntity</code></a> provides a way to |
| specify this information at runtime.</dd> |
| <dd><code>annotations</code> - an array of the annotations attached to the message entity instance.</dd> |
| <dd><code>mediaType</code> - the media type of the HTTP entity.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>length in bytes or -1 if the length cannot be determined in advance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeTo-java.lang.Object-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-jakarta.ws.rs.core.MultivaluedMap-java.io.OutputStream-"> |
| <!-- --> |
| </a><a name="writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-jakarta.ws.rs.core.MediaType-jakarta.ws.rs.core.MultivaluedMap-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre>void writeTo(<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="type parameter in MessageBodyWriter">T</a> t, |
| 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, |
| <a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.Object> httpHeaders, |
| java.io.OutputStream entityStream) |
| throws java.io.IOException, |
| <a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></pre> |
| <div class="block">Write a type to an HTTP message. The message 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 message body.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>t</code> - the instance to write.</dd> |
| <dd><code>type</code> - the class of instance that is to be written.</dd> |
| <dd><code>genericType</code> - the type of instance to be written. <a href="../../../../jakarta/ws/rs/core/GenericEntity.html" title="class in jakarta.ws.rs.core"><code>GenericEntity</code></a> provides a way to |
| specify this information at runtime.</dd> |
| <dd><code>annotations</code> - an array of the annotations attached to the message entity instance.</dd> |
| <dd><code>mediaType</code> - the media type of the HTTP entity.</dd> |
| <dd><code>httpHeaders</code> - a mutable map of the HTTP message headers.</dd> |
| <dd><code>entityStream</code> - the <code>OutputStream</code> for the HTTP entity. The implementation must not close the output |
| stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if an IO error arises.</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 message 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/MessageBodyReader.html" title="interface in jakarta.ws.rs.ext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/ext/ParamConverter.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/MessageBodyWriter.html" target="_top">Frames</a></li> |
| <li><a href="MessageBodyWriter.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> |
