http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/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 216a8a3..437dae0 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,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":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}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -294,101 +294,83 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </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#setHtmlBranding-java.lang.Object-">setHtmlBranding</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 branding in the header section of the page generated by the default HTML doc template.</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#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="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#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="i22" class="altColor"> +<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#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="i23" class="rowColor"> +<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#setHtmlLinks-java.lang.String:A-">setHtmlLinks</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>[] value)</code> <div class="block">Sets the links in the HTML nav section.</div> </td> </tr> -<tr id="i24" class="altColor"> +<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#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="i25" class="rowColor"> +<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#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="i26" class="altColor"> +<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#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="i27" class="rowColor"> +<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#setHtmlScript-java.lang.Object-">setHtmlScript</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 script section contents.</div> </td> </tr> -<tr id="i28" class="altColor"> +<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#setHtmlStyle-java.lang.Object-">setHtmlStyle</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="i29" class="rowColor"> +<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#setHtmlStylesheet-java.lang.Object-">setHtmlStylesheet</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="i30" class="altColor"> +<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="i31" class="rowColor"> +<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="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#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="i33" class="rowColor"> +<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#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="i34" class="altColor"> +<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#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 var-args to simplify setting array output.</div> </td> </tr> -<tr id="i35" class="rowColor"> +<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#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> @@ -811,161 +793,13 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> -<a name="setHtmlTitle-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<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.488">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> - It gets wrapped in a <code><xt><h1></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. - - <ul class='doctree'> - <li class='info'> - 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>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="setHtmlDescription-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<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.542">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> - It gets wrapped in a <code><xt><h2></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. - - <ul class='doctree'> - <li class='info'> - 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>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="setHtmlBranding-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setHtmlBranding</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.569">setHtmlBranding</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 branding in the header section of the page generated by the default HTML doc template. - - <p> - The format of this value is HTML. - - <p> - This is arbitrary HTML that can be added to the header section to provide basic custom branding on 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#branding--"><code>@HtmlDoc.branding()</code></a> annotation.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>value</code> - The HTML page branding. - 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> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>This object (for method chaining).</dd> -</dl> -</li> -</ul> <a name="setHtmlHeader-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <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.607">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> +<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.471">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> @@ -976,14 +810,11 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ 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>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <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> @@ -1008,7 +839,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.643">setHtmlLinks</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>[] value)</pre> +<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.508">setHtmlLinks</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>[] value)</pre> <div class="block">Sets the links in the HTML nav section. <p> @@ -1020,6 +851,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -1049,7 +881,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.683">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> +<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.549">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> @@ -1066,6 +898,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -1093,7 +926,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.717">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> +<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.584">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> @@ -1104,6 +937,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -1131,7 +965,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.751">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> +<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.619">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> @@ -1142,6 +976,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -1169,7 +1004,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setHtmlStyle</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.782">setHtmlStyle</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> +<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.651">setHtmlStyle</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> @@ -1177,6 +1012,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -1204,7 +1040,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setHtmlStylesheet</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.817">setHtmlStylesheet</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> +<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.687">setHtmlStylesheet</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> @@ -1219,6 +1055,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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>. + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#stylesheet--"><code>@HtmlDoc.stylesheet()</code></a> annotation.</div> @@ -1243,7 +1080,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setHtmlScript</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.848">setHtmlScript</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> +<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.719">setHtmlScript</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 script section contents. <p> @@ -1251,6 +1088,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -1278,7 +1116,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.862">setHtmlNoWrap</a>(boolean value)</pre> +<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.733">setHtmlNoWrap</a>(boolean value)</pre> <div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. <p> @@ -1297,7 +1135,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.877">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> +<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.748">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> @@ -1317,7 +1155,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.895">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> +<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.766">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> @@ -1340,7 +1178,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <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.913">setHtmlTemplate</a>(<a href="../../../../org/apache/juneau/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a> value)</pre> +<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.784">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> @@ -1363,7 +1201,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.919">flushBuffer</a>() +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.790">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/9b48e212/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 7489fbe..3891348 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html @@ -137,7 +137,7 @@ var activeTableTab = "activeTableTab"; <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#htmldoc--">htmldoc</a>=, <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--">favicon</a>="htdocs/juneau.png", <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#staticFiles--">staticFiles</a>="{htdocs:\'htdocs\',styles:\'styles\'}") -public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.203">RestServletDefault</a> +public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.207">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. @@ -365,7 +365,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.203">RestServletDefault</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.207">RestServletDefault</a>()</pre> </li> </ul> </li> @@ -385,9 +385,9 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <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#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>="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.224">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#summary--">summary</a>="Swagger documentation", + <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#description--">description</a>="Auto-generated swagger documentation for 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.227">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/9b48e212/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html index 8067faf..25ea5ea 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -92,7 +92,7 @@ <li class="blockList"> <hr> <br> -<pre>public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.78">HtmlDoc</a></pre> +<pre>public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.77">HtmlDoc</a></pre> <div class="block">Contains all the configurable annotations for the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a>. <p> @@ -131,9 +131,7 @@ </head> <body> <header> - <h1><xv>Page title</xv></h1> - <h2><xv>Page description</xv></h2> - <xv>Arbitrary page branding</xv> + <xv>Page header</xv> </header> <nav> <xv>Page links</xv> @@ -176,18 +174,6 @@ </tr> <tr class="rowColor"> <td class="colFirst"><code><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>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#branding--">branding</a></span></code> -<div class="block">Sets the HTML page branding in the header section of the page generated by the default HTML doc template.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code><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></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#description--">description</a></span></code> -<div class="block">Sets the HTML page subtitle in the header section of the page generated by the default HTML doc template.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><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>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#footer--">footer</a></span></code> <div class="block">Sets the HTML footer section contents.</div> </td> @@ -247,9 +233,10 @@ </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><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></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#title--">title</a></span></code> -<div class="block">Sets the HTML page title in the header section of the page generated by the default HTML doc template.</div> +<td class="colFirst"><code><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/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#widgets--">widgets</a></span></code> +<div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly + generate arbitrary replacement HTML.</div> </td> </tr> </table> @@ -267,161 +254,13 @@ <!-- --> </a> <h3>Element Detail</h3> -<a name="title--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>title</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.121">title</a></pre> -<div class="block">Sets the HTML page title in the header section of the page generated by the default HTML doc template. - - <p> - The format of this value is HTML (phrasing content only). - - <p> - It gets wrapped in a <code><xt><h1></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. - - <ul class='doctree'> - <li class='info'> - 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. - <li class='info'> - The entire header section can be rendered with arbitrary HTML using <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#header--"><code>header()</code></a>. - This annotation is ignored when the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#header--"><code>header()</code></a> annotation is specified. - </ul> - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlTitle-java.lang.String-"><code>RestConfig.setHtmlTitle(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlTitle-java.lang.Object-"><code>RestResponse.setHtmlTitle(Object)</code></a> methods.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="description--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>description</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.166">description</a></pre> -<div class="block">Sets the HTML page subtitle in the header section of the page generated by the default HTML doc template. - - <p> - The format of this value is HTML (phrasing content only). - - <p> - It gets wrapped in a <code><xt><h2></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. - - <ul class='doctree'> - <li class='info'> - 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. - <li class='info'> - The entire header section can be rendered with arbitrary HTML using <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#header--"><code>header()</code></a>. - This annotation is ignored when the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#header--"><code>header()</code></a> annotation is specified. - </ul> - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlDescription-java.lang.String-"><code>RestConfig.setHtmlDescription(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlDescription-java.lang.Object-"><code>RestResponse.setHtmlDescription(Object)</code></a> methods.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="branding--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>branding</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.190">branding</a></pre> -<div class="block">Sets the HTML page branding in the header section of the page generated by the default HTML doc template. - - <p> - The format of this value is HTML. - - <p> - This is arbitrary HTML that can be added to the header section to provide basic custom branding on 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> - Multiple values are combined with newlines into a single string. - - <p> - The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlBranding-java.lang.String-"><code>RestConfig.setHtmlBranding(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlBranding-java.lang.Object-"><code>RestResponse.setHtmlBranding(Object)</code></a> methods.</div> -<dl> -<dt>Default:</dt> -<dd>{}</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="header--"> +<a name="header--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>header</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.229">header</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.114">header</a></pre> <div class="block">Sets the HTML header section contents. <p> @@ -443,13 +282,11 @@ </p> <p> - When a value is specified, the <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#title--"><code>title()</code></a> and <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#description--"><code>description()</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>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Multiple values are combined with newlines into a single string. @@ -472,7 +309,7 @@ <ul class="blockList"> <li class="blockList"> <h4>links</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.270">links</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.156">links</a></pre> <div class="block">Sets the links in the HTML nav section. <p> @@ -500,6 +337,7 @@ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -525,7 +363,7 @@ <ul class="blockList"> <li class="blockList"> <h4>nav</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.311">nav</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.198">nav</a></pre> <div class="block">Sets the HTML nav section contents. <p> @@ -553,6 +391,7 @@ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -578,7 +417,7 @@ <ul class="blockList"> <li class="blockList"> <h4>aside</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.346">aside</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.234">aside</a></pre> <div class="block">Sets the HTML aside section contents. <p> @@ -600,6 +439,7 @@ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -625,7 +465,7 @@ <ul class="blockList"> <li class="blockList"> <h4>footer</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.381">footer</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.270">footer</a></pre> <div class="block">Sets the HTML footer section contents. <p> @@ -647,6 +487,7 @@ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -672,7 +513,7 @@ <ul class="blockList"> <li class="blockList"> <h4>style</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.414">style</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.304">style</a></pre> <div class="block">Sets the HTML CSS style section contents. <p> @@ -692,6 +533,7 @@ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -717,7 +559,7 @@ <ul class="blockList"> <li class="blockList"> <h4>stylesheet</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.445">stylesheet</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.336">stylesheet</a></pre> <div class="block">Sets the CSS URL in the HTML CSS style section. <p> @@ -741,6 +583,7 @@ <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>. + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> The programmatic equivalent to this annotation are the @@ -760,7 +603,7 @@ <ul class="blockList"> <li class="blockList"> <h4>script</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.477">script</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.369">script</a></pre> <div class="block">Sets the HTML script section contents. <p> @@ -779,6 +622,7 @@ <p> This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> A value of <js>"NONE"</js> can be used to force no value. @@ -804,7 +648,7 @@ <ul class="blockList"> <li class="blockList"> <h4>nowrap</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.485">nowrap</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.377">nowrap</a></pre> <div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. <p> @@ -824,7 +668,7 @@ <ul class="blockList"> <li class="blockList"> <h4>noResultsMessage</h4> -<pre>public abstract <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/annotation/HtmlDoc.html#line.490">noResultsMessage</a></pre> +<pre>public abstract <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/annotation/HtmlDoc.html#line.382">noResultsMessage</a></pre> <div class="block">Specifies the text to display when serializing an empty array or collection.</div> <dl> <dt>Default:</dt> @@ -838,10 +682,10 @@ <li class="blockList"><a name="template--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>template</h4> -<pre>public abstract <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>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.503">template</a></pre> +<pre>public abstract <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>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.395">template</a></pre> <div class="block">Specifies the template class to use for rendering the HTML page. <p> @@ -859,6 +703,27 @@ </ul> </li> </ul> +<ul class="blockList"> +<li class="blockList"><a name="widgets--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>widgets</h4> +<pre>public abstract <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/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.404">widgets</a></pre> +<div class="block">Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly + generate arbitrary replacement HTML. + + <p> + Widgets are inherited from parent to child, but can be overridden by reusing the widget name.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> </li> </ul> </div> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html index 50caa5b..607ac72 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Inherit.html @@ -269,7 +269,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>values</h4> -<pre>public static <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Inherit.html#line.19">values</a>()</pre> +<pre>public static <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Inherit.html#line.32">values</a>()</pre> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: @@ -289,7 +289,7 @@ for (Inherit c : Inherit.values()) <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> -<pre>public static <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Inherit.html#line.19">valueOf</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> +<pre>public static <a href="../../../../../org/apache/juneau/rest/annotation/Inherit.html" title="enum in org.apache.juneau.rest.annotation">Inherit</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Inherit.html#line.32">valueOf</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> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html b/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html index a39a8d5..b0436be 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/MethodSwagger.html @@ -92,7 +92,7 @@ <li class="blockList"> <hr> <br> -<pre>public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.18">MethodSwagger</a></pre> +<pre>public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.20">MethodSwagger</a></pre> <div class="block">Extended annotation for <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#swagger--"><code>RestMethod.swagger()</code></a>.</div> </li> </ul> @@ -163,7 +163,7 @@ <ul class="blockList"> <li class="blockList"> <h4>externalDocs</h4> -<pre>public abstract <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/annotation/MethodSwagger.html#line.56">externalDocs</a></pre> +<pre>public abstract <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/annotation/MethodSwagger.html#line.59">externalDocs</a></pre> <div class="block">Optional external documentation information for the exposed API. <p> @@ -194,7 +194,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.</div> @@ -213,7 +214,7 @@ <ul class="blockList"> <li class="blockList"> <h4>tags</h4> -<pre>public abstract <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/annotation/MethodSwagger.html#line.88">tags</a></pre> +<pre>public abstract <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/annotation/MethodSwagger.html#line.92">tags</a></pre> <div class="block">Optional tagging information for the exposed API. <p> @@ -238,7 +239,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.</div> @@ -257,7 +259,7 @@ <ul class="blockList"> <li class="blockList"> <h4>deprecated</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.116">deprecated</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.121">deprecated</a></pre> <div class="block">Optional deprecated flag for the exposed API. <p> @@ -278,7 +280,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.</div> @@ -297,7 +300,7 @@ <ul class="blockList"> <li class="blockList"> <h4>parameters</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.162">parameters</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.168">parameters</a></pre> <div class="block">Optional parameter descriptions. <p> @@ -336,7 +339,8 @@ English), and use resource bundles if you need to support localization. <p> - These annotations can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.</div> @@ -355,7 +359,7 @@ <ul class="blockListLast"> <li class="blockList"> <h4>responses</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.206">responses</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Response.html" title="annotation in org.apache.juneau.rest.annotation">Response</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/MethodSwagger.html#line.213">responses</a></pre> <div class="block">Optional output description. <p> @@ -395,7 +399,8 @@ English), and use resource bundles if you need to support localization. <p> - These annotations can contain variables (e.g. "$L{my.localized.variable}").</div> + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables.</div> <dl> <dt>Default:</dt> <dd>{}</dd> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html b/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html index 51469b2..1e18872 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/ResourceSwagger.html @@ -169,17 +169,23 @@ <ul class="blockList"> <li class="blockList"> <h4>termsOfService</h4> -<pre>public abstract <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/annotation/ResourceSwagger.html#line.36">termsOfService</a></pre> +<pre>public abstract <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/annotation/ResourceSwagger.html#line.42">termsOfService</a></pre> <div class="block">Optional servlet terms-of-service for this API. + <p> It is used to populate the Swagger terms-of-service field. + <p> The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle. (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>). + <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. + <p> Corresponds to the swagger field <code>/info/termsOfService</code>. + <p> The programmatic equivalent to this annotation is the <a href="../../../../../org/apache/juneau/rest/RestInfoProvider.html#getTermsOfService-org.apache.juneau.rest.RestRequest-"><code>RestInfoProvider.getTermsOfService(RestRequest)</code></a> method.</div> @@ -198,7 +204,7 @@ <ul class="blockList"> <li class="blockList"> <h4>contact</h4> -<pre>public abstract <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/annotation/ResourceSwagger.html#line.77">contact</a></pre> +<pre>public abstract <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/annotation/ResourceSwagger.html#line.84">contact</a></pre> <div class="block">Optional contact information for the exposed API. <p> @@ -229,7 +235,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/info/contact</code>. @@ -251,7 +258,7 @@ <ul class="blockList"> <li class="blockList"> <h4>license</h4> -<pre>public abstract <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/annotation/ResourceSwagger.html#line.117">license</a></pre> +<pre>public abstract <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/annotation/ResourceSwagger.html#line.125">license</a></pre> <div class="block">Optional license information for the exposed API. <p> @@ -281,7 +288,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/info/license</code>. @@ -303,7 +311,7 @@ <ul class="blockList"> <li class="blockList"> <h4>version</h4> -<pre>public abstract <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/annotation/ResourceSwagger.html#line.138">version</a></pre> +<pre>public abstract <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/annotation/ResourceSwagger.html#line.147">version</a></pre> <div class="block">Provides the version of the application API (not to be confused with the specification version). <p> @@ -314,7 +322,8 @@ (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>). <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/info/version</code>. @@ -336,7 +345,7 @@ <ul class="blockList"> <li class="blockList"> <h4>tags</h4> -<pre>public abstract <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/annotation/ResourceSwagger.html#line.184">tags</a></pre> +<pre>public abstract <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/annotation/ResourceSwagger.html#line.194">tags</a></pre> <div class="block">Optional tagging information for the exposed API. <p> @@ -372,7 +381,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/tags</code>. @@ -394,7 +404,7 @@ <ul class="blockListLast"> <li class="blockList"> <h4>externalDocs</h4> -<pre>public abstract <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/annotation/ResourceSwagger.html#line.225">externalDocs</a></pre> +<pre>public abstract <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/annotation/ResourceSwagger.html#line.236">externalDocs</a></pre> <div class="block">Optional external documentation information for the exposed API. <p> @@ -424,7 +434,8 @@ </p> <p> - This field can contain variables (e.g. "$L{my.localized.variable}"). + This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>). + See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/tags</code>. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html b/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html index b4cd5d6..a546906 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/Response.html @@ -96,7 +96,7 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER"; title="class or interface in java.lang.annotation">PARAMETER</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.44">Response</a></pre> +public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.46">Response</a></pre> <div class="block">Annotation used in conjunction with <a href="../../../../../org/apache/juneau/rest/annotation/MethodSwagger.html#responses--"><code>MethodSwagger.responses()</code></a> to identify possible responses by the method. <h5 class='section'>Example:</h5> @@ -193,7 +193,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>value</h4> -<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.49">value</a></pre> +<pre>public abstract int <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.51">value</a></pre> <div class="block">HTTP response code.</div> </li> </ul> @@ -207,7 +207,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public abstract <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/annotation/Response.html#line.65">description</a></pre> +<pre>public abstract <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/annotation/Response.html#line.68">description</a></pre> <div class="block">Optional description. <p> @@ -217,6 +217,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <p> This field can contain variables (e.g. "$L{my.localized.variable}"). + <br>See <a href="../../../../../org/apache/juneau/rest/RestContext.html#getVarResolver--"><code>RestContext.getVarResolver()</code></a> for the list of supported variables. <p> Corresponds to the swagger field <code>/paths/{path}/{method}/responses/{code}/description</code>.</div> @@ -235,7 +236,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>schema</h4> -<pre>public abstract <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/annotation/Response.html#line.88">schema</a></pre> +<pre>public abstract <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/annotation/Response.html#line.91">schema</a></pre> <div class="block">A definition of the response structure. <p> @@ -270,7 +271,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>headers</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.98">headers</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/Parameter.html" title="annotation in org.apache.juneau.rest.annotation">Parameter</a>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/Response.html#line.101">headers</a></pre> <div class="block">Optional response headers. <p>
