| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Response.ResponseBuilder</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="Response.ResponseBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":9,"i20":6,"i21":6,"i22":6,"i23":10,"i24":10,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="../../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/ws/rs/core/Response.ResponseBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Response.ResponseBuilder.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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">javax.ws.rs.core</div> |
| <h2 title="Class Response.ResponseBuilder" class="title">Class Response.ResponseBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.ws.rs.core.Response.ResponseBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">Response.ResponseBuilder</span> |
| extends java.lang.Object</pre> |
| <div class="block">A class used to build Response instances that contain metadata instead |
| of or in addition to an entity. An initial instance may be obtained via |
| static methods of the Response class, instance methods provide the |
| ability to set metadata. E.g. to create a response that indicates the |
| creation of a new resource: |
| <pre>@POST |
| Response addWidget(...) { |
| Widget w = ... |
| URI widgetId = UriBuilder.fromResource(Widget.class)... |
| return Response.created(widgetId).build(); |
| }</pre> |
| |
| <p>Several methods have parameters of type URI, <a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core"><code>UriBuilder</code></a> provides |
| convenient methods to create such values as does <code>URI.create()</code>.</p> |
| |
| <p>Where multiple variants of the same method are provided, the type of |
| the supplied parameter is retained in the metadata of the built |
| <code>Response</code>.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#ResponseBuilder--">ResponseBuilder</a></span>()</code> |
| <div class="block">Protected constructor, use one of the static methods of |
| <code>Response</code> to obtain an instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#allow-java.util.Set-">allow</a></span>(java.util.Set<java.lang.String> methods)</code> |
| <div class="block">Set the list of allowed methods for the resource.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#allow-java.lang.String...-">allow</a></span>(java.lang.String... methods)</code> |
| <div class="block">Set the list of allowed methods for the resource.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#build--">build</a></span>()</code> |
| <div class="block">Create a Response instance from the current ResponseBuilder.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#cacheControl-javax.ws.rs.core.CacheControl-">cacheControl</a></span>(<a href="../../../../javax/ws/rs/core/CacheControl.html" title="class in javax.ws.rs.core">CacheControl</a> cacheControl)</code> |
| <div class="block">Set the cache control data of the message.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#clone--">clone</a></span>()</code></td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#contentLocation-java.net.URI-">contentLocation</a></span>(java.net.URI location)</code> |
| <div class="block">Set the content location.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#cookie-javax.ws.rs.core.NewCookie...-">cookie</a></span>(<a href="../../../../javax/ws/rs/core/NewCookie.html" title="class in javax.ws.rs.core">NewCookie</a>... cookies)</code> |
| <div class="block">Add cookies to the response message.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#encoding-java.lang.String-">encoding</a></span>(java.lang.String encoding)</code> |
| <div class="block">Set the message entity content encoding.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#entity-java.lang.Object-">entity</a></span>(java.lang.Object entity)</code> |
| <div class="block">Set the response entity in the builder.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#entity-java.lang.Object-java.lang.annotation.Annotation:A-">entity</a></span>(java.lang.Object entity, |
| java.lang.annotation.Annotation[] annotations)</code> |
| <div class="block">Set the response entity in the builder.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#expires-java.util.Date-">expires</a></span>(java.util.Date expires)</code> |
| <div class="block">Set the response expiration date.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#header-java.lang.String-java.lang.Object-">header</a></span>(java.lang.String name, |
| java.lang.Object value)</code> |
| <div class="block">Add an arbitrary header.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#language-java.util.Locale-">language</a></span>(java.util.Locale language)</code> |
| <div class="block">Set the message entity language.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#language-java.lang.String-">language</a></span>(java.lang.String language)</code> |
| <div class="block">Set the message entity language.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#lastModified-java.util.Date-">lastModified</a></span>(java.util.Date lastModified)</code> |
| <div class="block">Set the response entity last modification date.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#link-java.lang.String-java.lang.String-">link</a></span>(java.lang.String uri, |
| java.lang.String rel)</code> |
| <div class="block">Add a link header.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#link-java.net.URI-java.lang.String-">link</a></span>(java.net.URI uri, |
| java.lang.String rel)</code> |
| <div class="block">Add a link header.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#links-javax.ws.rs.core.Link...-">links</a></span>(<a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core">Link</a>... links)</code> |
| <div class="block">Add one or more link headers.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#location-java.net.URI-">location</a></span>(java.net.URI location)</code> |
| <div class="block">Set the location.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#newInstance--">newInstance</a></span>()</code> |
| <div class="block">Create a new builder instance.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#replaceAll-javax.ws.rs.core.MultivaluedMap-">replaceAll</a></span>(<a href="../../../../javax/ws/rs/core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.Object> headers)</code> |
| <div class="block">Replaces all existing headers with the newly supplied headers.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#status-int-">status</a></span>(int status)</code> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#status-int-java.lang.String-">status</a></span>(int status, |
| java.lang.String reasonPhrase)</code> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#status-javax.ws.rs.core.Response.Status-">status</a></span>(<a href="../../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core">Response.Status</a> status)</code> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#status-javax.ws.rs.core.Response.StatusType-">status</a></span>(<a href="../../../../javax/ws/rs/core/Response.StatusType.html" title="interface in javax.ws.rs.core">Response.StatusType</a> status)</code> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#tag-javax.ws.rs.core.EntityTag-">tag</a></span>(<a href="../../../../javax/ws/rs/core/EntityTag.html" title="class in javax.ws.rs.core">EntityTag</a> tag)</code> |
| <div class="block">Set a response entity tag.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#tag-java.lang.String-">tag</a></span>(java.lang.String tag)</code> |
| <div class="block">Set a strong response entity tag.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-javax.ws.rs.core.MediaType-">type</a></span>(<a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a> type)</code> |
| <div class="block">Set the message entity media type.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-java.lang.String-">type</a></span>(java.lang.String type)</code> |
| <div class="block">Set the message entity media type.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#variant-javax.ws.rs.core.Variant-">variant</a></span>(<a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core">Variant</a> variant)</code> |
| <div class="block">Set message entity representation metadata.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#variants-java.util.List-">variants</a></span>(java.util.List<<a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core">Variant</a>> variants)</code> |
| <div class="block">Add a Vary header that lists the available variants.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#variants-javax.ws.rs.core.Variant...-">variants</a></span>(<a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core">Variant</a>... variants)</code> |
| <div class="block">Add a Vary header that lists the available variants.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ResponseBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ResponseBuilder</h4> |
| <pre>protected ResponseBuilder()</pre> |
| <div class="block">Protected constructor, use one of the static methods of |
| <code>Response</code> to obtain an instance.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newInstance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>protected static <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> newInstance()</pre> |
| <div class="block">Create a new builder instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a> build()</pre> |
| <div class="block">Create a Response instance from the current ResponseBuilder. The builder |
| is reset to a blank state equivalent to calling the ok method.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Response instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> clone()</pre> |
| <div class="block"> |
| <p> |
| Create a copy of the ResponseBuilder preserving its state. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>clone</code> in class <code>java.lang.Object</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of the ResponseBuilder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="status-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>status</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> status(int status)</pre> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - the response status.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if status is less than <code>100</code> or greater |
| than <code>599</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="status-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>status</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> status(int status, |
| java.lang.String reasonPhrase)</pre> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - the response status.</dd> |
| <dd><code>reasonPhrase</code> - the reason phrase.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if status is less than <code>100</code> or greater |
| than <code>599</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="status-javax.ws.rs.core.Response.StatusType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>status</h4> |
| <pre>public <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> status(<a href="../../../../javax/ws/rs/core/Response.StatusType.html" title="interface in javax.ws.rs.core">Response.StatusType</a> status)</pre> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - the response status.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if status is <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="status-javax.ws.rs.core.Response.Status-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>status</h4> |
| <pre>public <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> status(<a href="../../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core">Response.Status</a> status)</pre> |
| <div class="block">Set the status on the ResponseBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>status</code> - the response status.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if status is <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entity-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entity</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> entity(java.lang.Object entity)</pre> |
| <div class="block">Set the response entity in the builder. |
| <p /> |
| Any Java type instance for a response entity, that is supported by the |
| runtime can be passed. It is the callers responsibility to wrap the |
| actual entity with <a href="../../../../javax/ws/rs/core/GenericEntity.html" title="class in javax.ws.rs.core"><code>GenericEntity</code></a> if preservation of its generic |
| type is required. Note that the entity can be also set as an |
| <code>input stream</code>. |
| <p /> |
| A specific entity media type can be set using one of the <code>type(...)</code> |
| methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - the request entity.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>updated response builder instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#entity-java.lang.Object-java.lang.annotation.Annotation:A-"><code>entity(java.lang.Object, java.lang.annotation.Annotation[])</code></a>, |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-javax.ws.rs.core.MediaType-"><code>type(javax.ws.rs.core.MediaType)</code></a>, |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-java.lang.String-"><code>type(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entity-java.lang.Object-java.lang.annotation.Annotation:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entity</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> entity(java.lang.Object entity, |
| java.lang.annotation.Annotation[] annotations)</pre> |
| <div class="block">Set the response entity in the builder. |
| <p /> |
| Any Java type instance for a response entity, that is supported by the |
| runtime can be passed. It is the callers responsibility to wrap the |
| actual entity with <a href="../../../../javax/ws/rs/core/GenericEntity.html" title="class in javax.ws.rs.core"><code>GenericEntity</code></a> if preservation of its generic |
| type is required. Note that the entity can be also set as an |
| <code>input stream</code>. |
| <p /> |
| A specific entity media type can be set using one of the <code>type(...)</code> |
| methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - the request entity.</dd> |
| <dd><code>annotations</code> - annotations that will be passed to the <a href="../../../../javax/ws/rs/ext/MessageBodyWriter.html" title="interface in javax.ws.rs.ext"><code>MessageBodyWriter</code></a>, |
| (in addition to any annotations declared directly on a resource |
| method that returns the built response).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>updated response builder instance.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#entity-java.lang.Object-"><code>entity(java.lang.Object)</code></a>, |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-javax.ws.rs.core.MediaType-"><code>type(javax.ws.rs.core.MediaType)</code></a>, |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-java.lang.String-"><code>type(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allow-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allow</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> allow(java.lang.String... methods)</pre> |
| <div class="block">Set the list of allowed methods for the resource. Any duplicate method |
| names will be truncated to a single entry.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>methods</code> - the methods to be listed as allowed for the resource, |
| if <code>null</code> any existing allowed method list will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allow-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allow</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> allow(java.util.Set<java.lang.String> methods)</pre> |
| <div class="block">Set the list of allowed methods for the resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>methods</code> - the methods to be listed as allowed for the resource, |
| if <code>null</code> any existing allowed method list will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cacheControl-javax.ws.rs.core.CacheControl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cacheControl</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> cacheControl(<a href="../../../../javax/ws/rs/core/CacheControl.html" title="class in javax.ws.rs.core">CacheControl</a> cacheControl)</pre> |
| <div class="block">Set the cache control data of the message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cacheControl</code> - the cache control directives, if <code>null</code> |
| any existing cache control directives will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encoding-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encoding</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> encoding(java.lang.String encoding)</pre> |
| <div class="block">Set the message entity content encoding.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoding</code> - the content encoding of the message entity, |
| if <code>null</code> any existing value for content encoding will be |
| removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="header-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> header(java.lang.String name, |
| java.lang.Object value)</pre> |
| <div class="block">Add an arbitrary header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header</dd> |
| <dd><code>value</code> - the value of the header, the header will be serialized |
| using a <a href="../../../../javax/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html" title="interface in javax.ws.rs.ext"><code>RuntimeDelegate.HeaderDelegate</code></a> if |
| one is available via <a href="../../../../javax/ws/rs/ext/RuntimeDelegate.html#createHeaderDelegate-java.lang.Class-"><code>RuntimeDelegate.createHeaderDelegate(java.lang.Class)</code></a> |
| for the class of <code>value</code> or using its <code>toString</code> method |
| if a header delegate is not available. If <code>value</code> is <code>null</code> |
| then all current headers of the same name will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="replaceAll-javax.ws.rs.core.MultivaluedMap-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceAll</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> replaceAll(<a href="../../../../javax/ws/rs/core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.Object> headers)</pre> |
| <div class="block">Replaces all existing headers with the newly supplied headers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - new headers to be set, if <code>null</code> all existing |
| headers will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="language-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>language</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> language(java.lang.String language)</pre> |
| <div class="block">Set the message entity language.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>language</code> - the language of the message entity, if <code>null</code> any |
| existing value for language will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="language-java.util.Locale-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>language</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> language(java.util.Locale language)</pre> |
| <div class="block">Set the message entity language.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>language</code> - the language of the message entity, if <code>null</code> any |
| existing value for type will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-javax.ws.rs.core.MediaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> type(<a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a> type)</pre> |
| <div class="block">Set the message entity media type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the media type of the message entity. If <code>null</code>, any |
| existing value for type will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> type(java.lang.String type)</pre> |
| <div class="block">Set the message entity media type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the media type of the message entity. If <code>null</code>, any |
| existing value for type will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="variant-javax.ws.rs.core.Variant-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>variant</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> variant(<a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core">Variant</a> variant)</pre> |
| <div class="block">Set message entity representation metadata. |
| <p/> |
| Equivalent to setting the values of content type, content language, |
| and content encoding separately using the values of the variant properties.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>variant</code> - metadata of the message entity, a <code>null</code> value is |
| equivalent to a variant with all <code>null</code> properties.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#encoding-java.lang.String-"><code>encoding(java.lang.String)</code></a>, |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#language-java.util.Locale-"><code>language(java.util.Locale)</code></a>, |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#type-javax.ws.rs.core.MediaType-"><code>type(javax.ws.rs.core.MediaType)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="contentLocation-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentLocation</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> contentLocation(java.net.URI location)</pre> |
| <div class="block">Set the content location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>location</code> - the content location. Relative or absolute URIs |
| may be used for the value of content location. If <code>null</code> any |
| existing value for content location will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cookie-javax.ws.rs.core.NewCookie...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cookie</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> cookie(<a href="../../../../javax/ws/rs/core/NewCookie.html" title="class in javax.ws.rs.core">NewCookie</a>... cookies)</pre> |
| <div class="block">Add cookies to the response message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cookies</code> - new cookies that will accompany the response. A <code>null</code> |
| value will remove all cookies, including those added via the |
| <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html#header-java.lang.String-java.lang.Object-"><code>header(java.lang.String, java.lang.Object)</code></a> method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="expires-java.util.Date-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expires</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> expires(java.util.Date expires)</pre> |
| <div class="block">Set the response expiration date.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expires</code> - the expiration date, if <code>null</code> removes any existing |
| expires value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lastModified-java.util.Date-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lastModified</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> lastModified(java.util.Date lastModified)</pre> |
| <div class="block">Set the response entity last modification date.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lastModified</code> - the last modified date, if <code>null</code> any existing |
| last modified value will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="location-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>location</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> location(java.net.URI location)</pre> |
| <div class="block">Set the location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>location</code> - the location. If a relative URI is supplied it will be |
| converted into an absolute URI by resolving it relative to the |
| base URI of the application (see <a href="../../../../javax/ws/rs/core/UriInfo.html#getBaseUri--"><code>UriInfo.getBaseUri()</code></a>). |
| If <code>null</code> any existing value for location will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tag-javax.ws.rs.core.EntityTag-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tag</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> tag(<a href="../../../../javax/ws/rs/core/EntityTag.html" title="class in javax.ws.rs.core">EntityTag</a> tag)</pre> |
| <div class="block">Set a response entity tag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - the entity tag, if <code>null</code> any existing entity tag |
| value will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tag-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tag</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> tag(java.lang.String tag)</pre> |
| <div class="block">Set a strong response entity tag. |
| <p/> |
| This is a shortcut for <code>tag(new EntityTag(<i>value</i>))</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - the string content of a strong entity tag. The |
| runtime will quote the supplied value when creating the header. |
| If <code>null</code> any existing entity tag value will be removed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="variants-javax.ws.rs.core.Variant...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>variants</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> variants(<a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core">Variant</a>... variants)</pre> |
| <div class="block">Add a Vary header that lists the available variants.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>variants</code> - a list of available representation variants, a <code>null</code> |
| value will remove an existing value for Vary header.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="variants-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>variants</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> variants(java.util.List<<a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core">Variant</a>> variants)</pre> |
| <div class="block">Add a Vary header that lists the available variants.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>variants</code> - a list of available representation variants, a <code>null</code> |
| value will remove an existing value for Vary header.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="links-javax.ws.rs.core.Link...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>links</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> links(<a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core">Link</a>... links)</pre> |
| <div class="block">Add one or more link headers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>links</code> - links to be added to the message as headers, a <code>null</code> |
| value will remove any existing Link headers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="link-java.net.URI-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>link</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> link(java.net.URI uri, |
| java.lang.String rel)</pre> |
| <div class="block">Add a link header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - underlying URI for link header.</dd> |
| <dd><code>rel</code> - value of "rel" parameter.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="link-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>link</h4> |
| <pre>public abstract <a href="../../../../javax/ws/rs/core/Response.ResponseBuilder.html" title="class in javax.ws.rs.core">Response.ResponseBuilder</a> link(java.lang.String uri, |
| java.lang.String rel)</pre> |
| <div class="block">Add a link header.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - underlying URI for link header.</dd> |
| <dd><code>rel</code> - value of "rel" parameter.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated response builder.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</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="../../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/ws/rs/core/Response.ResponseBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Response.ResponseBuilder.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |