http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/RestResponse.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestResponse.html b/content/site/apidocs/org/apache/juneau/rest/RestResponse.html index c3d80ac..30c60e9 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestResponse.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestResponse.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -285,36 +285,96 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </tr> <tr id="i18" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-">setOutput</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output)</code> -<div class="block">Sets the HTTP output on the response.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlAside-java.lang.Object-">setHtmlAside</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML aside section contents.</div> </td> </tr> <tr id="i19" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutputs-java.lang.Object...-">setOutputs</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... output)</code> -<div class="block">Shortcut method that allows you to use varargs to simplify setting array output.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlCss-java.lang.Object-">setHtmlCss</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML CSS style section contents.</div> </td> </tr> <tr id="i20" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setPageLinks-java.lang.Object-">setPageLinks</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> links)</code> -<div class="block">Sets the page text for HTML views.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlCssUrl-java.lang.Object-">setHtmlCssUrl</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the CSS URL in the HTML CSS style section.</div> </td> </tr> <tr id="i21" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setPageText-java.lang.Object-">setPageText</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> text)</code> -<div class="block">Sets the page text for HTML views.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlDescription-java.lang.Object-">setHtmlDescription</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML page description.</div> </td> </tr> <tr id="i22" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setPageTitle-java.lang.Object-">setPageTitle</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> title)</code> -<div class="block">Sets the page title for HTML views.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlFooter-java.lang.Object-">setHtmlFooter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML footer section contents.</div> </td> </tr> <tr id="i23" class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlHeader-java.lang.Object-">setHtmlHeader</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML header section contents.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.Object-">setHtmlLinks</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the links in the HTML nav section.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNav-java.lang.Object-">setHtmlNav</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML nav section contents.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNoResultsMessage-java.lang.Object-">setHtmlNoResultsMessage</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Specifies the text to display when serializing an empty array or collection.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlNoWrap-boolean-">setHtmlNoWrap</a></span>(boolean value)</code> +<div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTemplate-java.lang.Class-">setHtmlTemplate</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> value)</code> +<div class="block">Specifies the template class to use for rendering the HTML page.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTemplate-org.apache.juneau.html.HtmlDocTemplate-">setHtmlTemplate</a></span>(<a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a> value)</code> +<div class="block">Specifies the template class to use for rendering the HTML page.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTitle-java.lang.Object-">setHtmlTitle</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Sets the HTML page title.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-">setOutput</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output)</code> +<div class="block">Sets the HTTP output on the response.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutputs-java.lang.Object...-">setOutputs</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... output)</code> +<div class="block">Shortcut method that allows you to use varargs to simplify setting array output.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestResponse.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> <div class="block">Add a serializer property to send to the serializers to override a default value.</div> @@ -727,81 +787,425 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> -<a name="setPageTitle-java.lang.Object-"> +<a name="setHtmlTitle-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setPageTitle</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.443">setPageTitle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> title)</pre> -<div class="block">Sets the page title for HTML views. +<h4>setHtmlTitle</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.467">setHtmlTitle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML page title. + <p> + The format of this value is plain text. <p> - This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource#pageTitle()</code></a>/ - <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageTitle--"><code>@RestMethod#pageTitle()</code></a> annotations. + It gets wrapped in a <code><xt><h3> <xa>class</xa>=<xs>'title'</xs>></xt></code> element and then added + to the <code><xt><header></code> section on the page. + <p> + If not specified, the page title is pulled from one of the following locations: + <ol> + <li><code>{servletClass}.{methodName}.pageTitle</code> resource bundle value. + <li><code>{servletClass}.pageTitle</code> resource bundle value. + <li><code><ja>@RestResource</ja>(title)</code> annotation. + <li><code>{servletClass}.title</code> resource bundle value. + <li><code>info/title</code> entry in swagger file. + </ol> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. <p> - This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_title</jsf>, title);</code> <ul class='doctree'> <li class='info'> - <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate a page title with delayed serialization so as not to - waste string concatenation cycles on non-HTML views. - </ul></div> + In most cases, you'll simply want to use the <code>@RestResource(title)</code> annotation to specify the + page title. + However, this annotation is provided in cases where you want the page title to be different that the one + shown in the swagger document. + </ul> + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#title--"><code>@HtmlDoc.title()</code></a> annotation.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>title</code> - The localized page title to render on the page. - Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>.</dd> +<dd><code>value</code> - The HTML page title. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>This object (for method chaining).</dd> </dl> </li> </ul> -<a name="setPageText-java.lang.Object-"> +<a name="setHtmlDescription-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setPageText</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.463">setPageText</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> text)</pre> -<div class="block">Sets the page text for HTML views. +<h4>setHtmlDescription</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.514">setHtmlDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML page description. + <p> + The format of this value is plain text. <p> - This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource#pageText()</code></a>/ - <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageText--"><code>@RestMethod#pageText()</code></a> annotations. + It gets wrapped in a <code><xt><h5> <xa>class</xa>=<xs>'description'</xs>></xt></code> element and then + added to the <code><xt><header></code> section on the page. + <p> + If not specified, the page title is pulled from one of the following locations: + <ol> + <li><code>{servletClass}.{methodName}.pageText</code> resource bundle value. + <li><code>{servletClass}.pageText</code> resource bundle value. + <li><code><ja>@RestMethod</ja>(summary)</code> annotation. + <li><code>{servletClass}.{methodName}.summary</code> resource bundle value. + <li><code>summary</code> entry in swagger file for method. + <li><code>{servletClass}.description</code> resource bundle value. + <li><code>info/description</code> entry in swagger file. + </ol> + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. <p> - This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_text</jsf>, text);</code> <ul class='doctree'> <li class='info'> - <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate page text with delayed serialization so as not to - waste string concatenation cycles on non-HTML views. - </ul></div> + In most cases, you'll simply want to use the <code>@RestResource(description)</code> or + <code>@RestMethod(summary)</code> annotations to specify the page text. + However, this annotation is provided in cases where you want the text to be different that the values shown + in the swagger document. + </ul> + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#description--"><code>@HtmlDoc.description()</code></a> annotation.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>text</code> - The localized page text to render on the page.</dd> +<dd><code>value</code> - The HTML page description. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>This object (for method chaining).</dd> </dl> </li> </ul> -<a name="setPageLinks-java.lang.Object-"> +<a name="setHtmlHeader-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setPageLinks</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.484">setPageLinks</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> links)</pre> -<div class="block">Sets the page text for HTML views. +<h4>setHtmlHeader</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.544">setHtmlHeader</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML header section contents. <p> - This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource#pageLinks()</code></a>/ - <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageLinks--"><code>@RestMethod#pageLinks()</code></a> annotations. + The format of this value is HTML. <p> - This is a shortcut for calling <code>setProperty(<jsf>HTMLDOC_links</jsf>, links);</code> - - <ul class='doctree'> - <li class='info'> - <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate page links with delayed serialization so as not to - waste string concatenation cycles on non-HTML views. - </ul></div> + The page header normally contains the title and description, but this value can be used to override the contents + to be whatever you want. + <p> + When a value is specified, the <a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTitle-java.lang.Object-"><code>setHtmlTitle(Object)</code></a> and <a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlDescription-java.lang.Object-"><code>setHtmlDescription(Object)</code></a> values will be ignored. + <p> + A value of <js>"NONE"</js> can be used to force no header. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#header--"><code>@HtmlDoc.header()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML header section contents. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlLinks-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlLinks</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.574">setHtmlLinks</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the links in the HTML nav section. + <p> + The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are + relative (to the servlet) or absolute URLs. + <p> + The page links are positioned immediately under the title and text. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + This field can also use URIs of any support type in <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#links--"><code>@HtmlDoc.links()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML nav section links links. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlNav-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlNav</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.606">setHtmlNav</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML nav section contents. + <p> + The format of this value is HTML. + <p> + The nav section of the page contains the links. + <p> + The format of this value is HTML. + <p> + When a value is specified, the <a href="../../../../org/apache/juneau/rest/RestResponse.html#setHtmlLinks-java.lang.Object-"><code>setHtmlLinks(Object)</code></a> value will be ignored. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#nav--"><code>@HtmlDoc.nav()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML nav section contents. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlAside-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlAside</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.634">setHtmlAside</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML aside section contents. + <p> + The format of this value is HTML. + <p> + The aside section typically floats on the right side of the page. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#aside--"><code>@HtmlDoc.aside()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML aside section contents. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlFooter-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlFooter</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.662">setHtmlFooter</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML footer section contents. + <p> + The format of this value is HTML. + <p> + The footer section typically floats on the bottom of the page. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#footer--"><code>@HtmlDoc.footer()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML footer section contents. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlCss-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlCss</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.688">setHtmlCss</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the HTML CSS style section contents. + <p> + The format of this value is CSS. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <p> + A value of <js>"NONE"</js> can be used to force no value. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#css--"><code>@HtmlDoc.css()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML CSS style section contents. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlCssUrl-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlCssUrl</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.717">setHtmlCssUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Sets the CSS URL in the HTML CSS style section. + <p> + The format of this value is a URL. + <p> + Specifies the URL to the stylesheet to add as a link in the style tag in the header. + <p> + The format of this value is CSS. + <p> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined + by <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a>. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#cssUrl--"><code>@HtmlDoc.cssUrl()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The CSS URL in the HTML CSS style section. + Object will be converted to a string using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> + <ul class='doctree'> + <li class='info'> + <b>Tip:</b> Use <a href="../../../../org/apache/juneau/utils/StringMessage.html" title="class in org.apache.juneau.utils"><code>StringMessage</code></a> to generate value with delayed serialization so as not to + waste string concatenation cycles on non-HTML views. + </ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlNoWrap-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlNoWrap</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.730">setHtmlNoWrap</a>(boolean value)</pre> +<div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#nowrap--"><code>@HtmlDoc.nowrap()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The new nowrap setting.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlNoResultsMessage-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlNoResultsMessage</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.743">setHtmlNoResultsMessage</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Specifies the text to display when serializing an empty array or collection. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#noResultsMessage--"><code>@HtmlDoc.noResultsMessage()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The text to display when serializing an empty array or collection.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlTemplate-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlTemplate</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.760">setHtmlTemplate</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>> value)</pre> +<div class="block">Specifies the template class to use for rendering the HTML page. + <p> + By default, uses <a href="../../../../org/apache/juneau/html/HtmlDocTemplateBasic.html" title="class in org.apache.juneau.html"><code>HtmlDocTemplateBasic</code></a> to render the contents, although you can provide + your own custom renderer or subclasses from the basic class to have full control over how the page is + rendered. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#template--"><code>@HtmlDoc.template()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML page template to use to render the HTML page.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="setHtmlTemplate-org.apache.juneau.html.HtmlDocTemplate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHtmlTemplate</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.777">setHtmlTemplate</a>(<a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a> value)</pre> +<div class="block">Specifies the template class to use for rendering the HTML page. + <p> + By default, uses <a href="../../../../org/apache/juneau/html/HtmlDocTemplateBasic.html" title="class in org.apache.juneau.html"><code>HtmlDocTemplateBasic</code></a> to render the contents, although you can provide + your own custom renderer or subclasses from the basic class to have full control over how the page is + rendered. + <p> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#template--"><code>@HtmlDoc.template()</code></a> annotation.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>links</code> - The localized page links render on the page.</dd> +<dd><code>value</code> - The HTML page template to use to render the HTML page.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>This object (for method chaining).</dd> </dl> @@ -813,7 +1217,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockListLast"> <li class="blockList"> <h4>flushBuffer</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.490">flushBuffer</a>() +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.783">flushBuffer</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html b/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html index 1011f61..5d924b0 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html @@ -131,13 +131,13 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">@RestResource</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--">serializers</a>={<a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html">HtmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.html" title="class in org.apache.juneau.html">HtmlStrippedDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlSchemaDocSerializer.html" title="class in org.apache.juneau.html">HtmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.Simple.html" title="class in org.apache.juneau.json">JsonSerializer.Simple.class</a>,<a href="../../../../org/apac he/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json">JsonSchemaSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlDocSerializer.html" title="class in org.apache.juneau.xml">XmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlSchemaDocSerializer.html" title="class in org.apache.juneau.xml">XmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/uon/UonSerializer.html" title="class in org.apache.juneau.uon">UonSerializer.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer.class</a>,<a href="../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack">MsgPackSerializer.class</a>,<a href="../../../../org/apache/juneau/soap/SoapXmlSerializer.html" title="class in org.apache.juneau.soap">SoapXmlSerializer.class</a>,<a href="../../../../org/apache/juneau/plainte xt/PlainTextSerializer.html" title="class in org.apache.juneau.plaintext">PlainTextSerializer.class</a>,<a href="../../../../org/apache/juneau/jso/JsoSerializer.html" title="class in org.apache.juneau.jso">JsoSerializer.class</a>}, +<pre><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">@RestResource</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#serializers--">serializers</a>={<a href="../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html">HtmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.html" title="class in org.apache.juneau.html">HtmlStrippedDocSerializer.class</a>,<a href="../../../../org/apache/juneau/html/HtmlSchemaDocSerializer.html" title="class in org.apache.juneau.html">HtmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer.class</a>,<a href="../../../../org/apache/juneau/json/JsonSerializer.Simple.html" title="class in org.apache.juneau.json">JsonSerializer.Simple.class</a>,<a href="../../../../org/apac he/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json">JsonSchemaSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlDocSerializer.html" title="class in org.apache.juneau.xml">XmlDocSerializer.class</a>,<a href="../../../../org/apache/juneau/xml/XmlSchemaDocSerializer.html" title="class in org.apache.juneau.xml">XmlSchemaDocSerializer.class</a>,<a href="../../../../org/apache/juneau/uon/UonSerializer.html" title="class in org.apache.juneau.uon">UonSerializer.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer.class</a>,<a href="../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack">MsgPackSerializer.class</a>,<a href="../../../../org/apache/juneau/soap/SoapXmlSerializer.html" title="class in org.apache.juneau.soap">SoapXmlSerializer.class</a>,<a href="../../../../org/apache/juneau/plainte xt/PlainTextSerializer.html" title="class in org.apache.juneau.plaintext">PlainTextSerializer.class</a>}, <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#parsers--">parsers</a>={<a href="../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json">JsonParser.class</a>,<a href="../../../../org/apache/juneau/xml/XmlParser.html" title="class in org.apache.juneau.xml">XmlParser.class</a>,<a href="../../../../org/apache/juneau/html/HtmlParser.html" title="class in org.apache.juneau.html">HtmlParser.class</a>,<a href="../../../../org/apache/juneau/uon/UonParser.html" title="class in org.apache.juneau.uon">UonParser.class</a>,<a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding">UrlEncodingParser.class</a>,<a href="../../../../org/apache/juneau/msgpack/MsgPackParser.html" title="class in org.apache.juneau.msgpack">MsgPackParser.class</a>,<a href="../../../../org/apache/juneau/plaintext/PlainTextParser.html" title="class in org.apache.juneau.plaintext">PlainT extParser.class</a>}, <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#properties--">properties</a>=<a href="../../../../org/apache/juneau/rest/annotation/Property.html" title="annotation in org.apache.juneau.rest.annotation">@Property</a>(<a href="../../../../org/apache/juneau/rest/annotation/Property.html#name--">name</a>="RestServlet.allowMethodParam",<a href="../../../../org/apache/juneau/rest/annotation/Property.html#value--">value</a>="OPTIONS"), <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--">stylesheet</a>="styles/juneau.css", <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--">favicon</a>="juneau.png", <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--">staticFiles</a>="{htdocs:\'htdocs\'}") -public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.190">RestServletDefault</a> +public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.189">RestServletDefault</a> extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest">RestServlet</a></pre> <div class="block">Subclass of <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> with default serializers and parsers defined. <p> @@ -358,7 +358,7 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <ul class="blockListLast"> <li class="blockList"> <h4>RestServletDefault</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.190">RestServletDefault</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.189">RestServletDefault</a>()</pre> </li> </ul> </li> @@ -377,10 +377,10 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <h4>getOptions</h4> <pre><a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html" title="annotation in org.apache.juneau.rest.annotation">@RestMethod</a>(<a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#name--">name</a>="OPTIONS", <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#path--">path</a>="/*", - <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#pageLinks--">pageLinks</a>="{back:\'$R{servletURI}\'}", + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--">htmldoc</a>=, <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#summary--">summary</a>="Resource options", - <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Description of this resource") -public <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.204">getOptions</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Swagger documentation") +public <a href="../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.207">getOptions</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> <div class="block">[OPTIONS /*] - Show resource options.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html b/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html index 0f0f7ea..c8c43a5 100644 --- a/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html +++ b/content/site/apidocs/org/apache/juneau/rest/StreamResource.Builder.html @@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public static class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.107">StreamResource.Builder</a> +<pre>public static class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.109">StreamResource.Builder</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Builder class for constructing <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><code>StreamResource</code></a> objects.</div> </li> @@ -215,7 +215,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>Builder</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.107">Builder</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.109">Builder</a>()</pre> </li> </ul> </li> @@ -232,7 +232,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>mediaType</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.117">mediaType</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> mediaType)</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.119">mediaType</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> mediaType)</pre> <div class="block">Specifies the resource media type string.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -248,7 +248,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>mediaType</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.127">mediaType</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.129">mediaType</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType)</pre> <div class="block">Specifies the resource media type string.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -264,7 +264,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>contents</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.149">contents</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... contents)</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.151">contents</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... contents)</pre> <div class="block">Specifies the contents for this resource. <p> This method can be called multiple times to add more content.</div> @@ -291,7 +291,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>header</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.161">header</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.163">header</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> <div class="block">Specifies an HTTP response header value.</div> <dl> @@ -309,7 +309,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>headers</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.172">headers</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> headers)</pre> +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.Builder.html" title="class in org.apache.juneau.rest">StreamResource.Builder</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.174">headers</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> headers)</pre> <div class="block">Specifies HTTP response header values.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -325,7 +325,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>build</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.184">build</a>() +<pre>public <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest">StreamResource</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.Builder.html#line.186">build</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Create a new <a href="../../../../org/apache/juneau/rest/StreamResource.html" title="class in org.apache.juneau.rest"><code>StreamResource</code></a> using values in this builder.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/StreamResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/StreamResource.html b/content/site/apidocs/org/apache/juneau/rest/StreamResource.html index 622e6ce..56c2f7b 100644 --- a/content/site/apidocs/org/apache/juneau/rest/StreamResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/StreamResource.html @@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.33">StreamResource</a> +<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.35">StreamResource</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> implements <a href="../../../../org/apache/juneau/Streamable.html" title="interface in org.apache.juneau">Streamable</a></pre> <div class="block">Represents the contents of a byte stream file with convenience methods for adding HTTP response headers. @@ -235,7 +235,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockList"> <li class="blockList"> <h4>StreamResource</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.54">StreamResource</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType, +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.56">StreamResource</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... contents) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Constructor.</div> @@ -263,7 +263,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockListLast"> <li class="blockList"> <h4>StreamResource</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.74">StreamResource</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType, +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.76">StreamResource</a>(<a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> mediaType, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> headers, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>... contents) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> @@ -301,7 +301,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockList"> <li class="blockList"> <h4>getHeaders</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.193">getHeaders</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.195">getHeaders</a>()</pre> <div class="block">Get the HTTP response headers.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -315,7 +315,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockList"> <li class="blockList"> <h4>streamTo</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.198">streamTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> os) +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.200">streamTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> os) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/juneau/Streamable.html#streamTo-java.io.OutputStream-">Streamable</a></code></span></div> <div class="block">Serialize this object to the specified output stream.</div> @@ -335,7 +335,7 @@ implements <a href="../../../../org/apache/juneau/Streamable.html" title="interf <ul class="blockListLast"> <li class="blockList"> <h4>getMediaType</h4> -<pre>public <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.204">getMediaType</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/http/MediaType.html" title="class in org.apache.juneau.http">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/StreamResource.html#line.206">getMediaType</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/juneau/Streamable.html#getMediaType--">Streamable</a></code></span></div> <div class="block">Returns the serialized media type for this resource (e.g. <js>"text/html"</js>).</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/017373e3/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html index 1b2f6b0..da578b7 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Header.html @@ -43,7 +43,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/annotation/HasQuery.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/rest/annotation/Header.html" target="_top">Frames</a></li> @@ -233,7 +233,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/rest/annotation/HasQuery.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/rest/annotation/Header.html" target="_top">Frames</a></li>
