http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/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 f03e682..34fd28e 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}; +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 tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -300,89 +300,95 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </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#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="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#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="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#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="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#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="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#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="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#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="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#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="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#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="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#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"> +<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"> +<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"> <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#setHtmlStyleImport-java.lang.Object-">setHtmlStyleImport</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"> +<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="i30" 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#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="i31" 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#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="i32" class="altColor"> +<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#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="i33" class="rowColor"> +<tr id="i34" 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 var-args to simplify setting array output.</div> </td> </tr> -<tr id="i34" class="altColor"> +<tr id="i35" 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> @@ -1158,13 +1164,13 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> -<a name="setHtmlCss-java.lang.Object-"> +<a name="setHtmlStyle-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.783">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> +<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.783">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,7 +1183,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ 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> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#style--"><code>@HtmlDoc.style()</code></a> annotation.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>value</code> - The HTML CSS style section contents. @@ -1193,17 +1199,17 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> -<a name="setHtmlCssUrl-java.lang.Object-"> +<a name="setHtmlStyleImport-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.818">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> +<h4>setHtmlStyleImport</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.818">setHtmlStyleImport</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. + The format of this value is a comma-delimited list of URLs. <p> Specifies the URL to the stylesheet to add as a link in the style tag in the header. @@ -1216,7 +1222,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ 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> + This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#styleImport--"><code>@HtmlDoc.styleImport()</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. @@ -1232,13 +1238,48 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ </dl> </li> </ul> +<a name="setHtmlScript-java.lang.Object-"> +<!-- --> +</a> +<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.849">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> + The format of this value is Javascript. + + <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#script--"><code>@HtmlDoc.script()</code></a> annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The HTML script 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="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.832">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.863">setHtmlNoWrap</a>(boolean value)</pre> <div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. <p> @@ -1257,7 +1298,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.847">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.878">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> @@ -1277,7 +1318,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.865">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.896">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> @@ -1300,7 +1341,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.883">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.914">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> @@ -1323,7 +1364,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.889">flushBuffer</a>() +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.920">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/b5c66cf1/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 d03f962..6e79690 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServletDefault.html @@ -134,11 +134,10 @@ var activeTableTab = "activeTableTab"; <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#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\'}") -public abstract class <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.199">RestServletDefault</a> + <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> 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. @@ -261,7 +260,7 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <h6 class='topic'>Other Notes</h6> <ul class='spaced-list'> <li> - Provides a default HTML stylesheet by setting <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--"><code>@RestResource.stylesheet()</code></a> + Provides a default HTML stylesheet by setting <a href="../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#styleImport--"><code>@HtmlDoc.styleImport()</code></a> to <js>"styles/juneau.css"</js>. <li> Provides a default favicon by setting <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--"><code>@RestResource.favicon()</code></a> to @@ -366,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.199">RestServletDefault</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestServletDefault.html#line.203">RestServletDefault</a>()</pre> </li> </ul> </li> @@ -388,7 +387,7 @@ extends <a href="../../../../org/apache/juneau/rest/RestServlet.html" title="cla <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.217">getOptions</a>(<a href="../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> +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.221">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/b5c66cf1/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 8dcb7f0..7eba112 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/HtmlDoc.html @@ -182,18 +182,6 @@ </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#css--">css</a></span></code> -<div class="block">Sets the HTML CSS style section contents.</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#cssUrl--">cssUrl</a></span></code> -<div class="block">Sets the CSS URL in the HTML CSS style section.</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> @@ -235,12 +223,30 @@ </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#script--">script</a></span></code> +<div class="block">Sets the HTML script section contents.</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#style--">style</a></span></code> +<div class="block">Sets the HTML CSS style section contents.</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#styleImport--">styleImport</a></span></code> +<div class="block">Sets the CSS URL in the HTML CSS style section.</div> +</td> +</tr> +<tr class="altColor"> <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/html/HtmlDocTemplate.html" title="interface in org.apache.juneau.html">HtmlDocTemplate</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html#template--">template</a></span></code> <div class="block">Specifies the template class to use for rendering the HTML page.</div> </td> </tr> -<tr class="altColor"> +<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> @@ -630,13 +636,13 @@ </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="css--"> +<li class="blockList"><a name="style--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>css</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.378">css</a></pre> +<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.378">style</a></pre> <div class="block">Sets the HTML CSS style section contents. <p> @@ -646,7 +652,7 @@ <p class='bcode'> <ja>@RestResource</ja>( htmldoc=<ja>@HtmlDoc</ja>( - css=<js>".red{color:red;}\n.blue{color:blue}"</js> + style=<js>".red{color:red;}\n.blue{color:blue}"</js> ) ) </p> @@ -659,7 +665,7 @@ <p> The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlCss-java.lang.String-"><code>RestConfig.setHtmlCss(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlCss-java.lang.Object-"><code>RestResponse.setHtmlCss(Object)</code></a> methods.</div> + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStyle-java.lang.String-"><code>RestConfig.setHtmlStyle(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStyle-java.lang.Object-"><code>RestResponse.setHtmlStyle(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -669,13 +675,13 @@ </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="cssUrl--"> +<li class="blockList"><a name="styleImport--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>cssUrl</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.409">cssUrl</a></pre> +<h4>styleImport</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.409">styleImport</a></pre> <div class="block">Sets the CSS URL in the HTML CSS style section. <p> @@ -702,10 +708,49 @@ <p> The programmatic equivalent to this annotation are the - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlCssUrl-java.lang.String-"><code>RestConfig.setHtmlCssUrl(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlCssUrl-java.lang.Object-"><code>RestResponse.setHtmlCssUrl(Object)</code></a> methods.</div> + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlStyleImport-java.lang.String-"><code>RestConfig.setHtmlStyleImport(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlStyleImport-java.lang.Object-"><code>RestResponse.setHtmlStyleImport(Object)</code></a> methods.</div> <dl> <dt>Default:</dt> -<dd>"servlet:/style.css"</dd> +<dd>""</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="script--"> +<!-- --> +</a> +<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.436">script</a></pre> +<div class="block">Sets the HTML script section contents. + + <p> + The format of this value is Javascript. + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <ja>@RestResource</ja>( + htmldoc=<ja>@HtmlDoc</ja>( + script=<js>"alert('Hello!')"</js> + ) + ) + </p> + + <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> + The programmatic equivalent to this annotation are the + <a href="../../../../../org/apache/juneau/rest/RestConfig.html#setHtmlScript-java.lang.String-"><code>RestConfig.setHtmlScript(String)</code></a>/<a href="../../../../../org/apache/juneau/rest/RestResponse.html#setHtmlScript-java.lang.Object-"><code>RestResponse.setHtmlScript(Object)</code></a> methods.</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> </dl> </li> </ul> @@ -718,7 +763,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.417">nowrap</a></pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/juneau/rest/annotation/HtmlDoc.html#line.444">nowrap</a></pre> <div class="block">Shorthand method for forcing the rendered HTML content to be no-wrap. <p> @@ -738,7 +783,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.422">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.449">noResultsMessage</a></pre> <div class="block">Specifies the text to display when serializing an empty array or collection.</div> <dl> <dt>Default:</dt> @@ -755,7 +800,7 @@ <ul class="blockListLast"> <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.435">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.462">template</a></pre> <div class="block">Specifies the template class to use for rendering the HTML page. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html index 03c993d..4e97773 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestResource.html @@ -293,24 +293,18 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </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/RestResource.html#stylesheet--">stylesheet</a></span></code> -<div class="block">The stylesheet to use for HTML views.</div> -</td> -</tr> -<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#swagger--">swagger</a></span></code> <div class="block">Provides swagger-specific metadata on this resource.</div> </td> </tr> -<tr class="altColor"> +<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/RestResource.html#title--">title</a></span></code> <div class="block">Optional servlet title.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <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/RestResource.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 @@ -990,94 +984,17 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota </li> </ul> <ul class="blockList"> -<li class="blockList"><a name="stylesheet--"> -<!-- --> -</a> -<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/RestResource.html#line.543">stylesheet</a></pre> -<div class="block">The stylesheet to use for HTML views. - - <p> - The name is a path to a stylesheet located in either the classpath or working directory. - The resulting stylesheet becomes available through the servlet via the URL <js>"[servlet-path]/style.css"</js>. - - <p> - The default set of styles located in the <code>org.apache.juneau.rest.styles</code> package are: - <ul class='spaced-list'> - <li> - <js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel. - <li> - <js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel. - </ul> - - <p> - The classpath search starts with the child servlet class and proceeds up the class hierarchy chain. - Since the <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>RestServlet</code></a> class is in the <code>org.apache.juneau.rest</code> package and the predefined - styles are in the <code>org.apache.juneau.rest.styles</code> package, the paths to the predefined styles are - prefixed with <js>"styles/"</js>. - - <p> - If the stylesheet cannot be found on the classpath, an attempt to look in the working directory for it will be - made. - This allows for stylesheets to be placed on the file system in the working directory. - - <p> - If the file cannot be located, the request to <js>"[servlet-path]/style.css"</js> will return - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_FOUND"; title="class or interface in javax.servlet.http"><code>HttpServletResponse.SC_NOT_FOUND</code></a>. - - <h5 class='section'>Example:</h5> - <p class='bcode'> - <jk>package</jk> com.foo.mypackage; - - <ja>@RestResource</ja>( - stylesheet=<js>"mystyles/mycss.css"</js> - ) - <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault { - } - </p> - - <p> - In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered - locations: - </p> - <ol> - <li><code>com.foo.mypackage.mystyles</code> package. - <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in - <code>org.apache.juneau.rest</code>). - <li><code>[working-dir]/mystyles</code> directory. - </ol> - - <p> - Multiple stylesheets can be specified as a comma-delimited list. - When multiple stylesheets are specified, their contents will be concatenated and return in the order specified - in the list. - - <p> - The programmatic equivalent to this annotation are the <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addStyleSheet-java.lang.Object...-"><code>RestConfig.addStyleSheet(Object...)</code></a>/ - <a href="../../../../../org/apache/juneau/rest/RestConfig.html#addStyleSheet-java.lang.Class-java.lang.String-"><code>RestConfig.addStyleSheet(Class, String)</code></a> methods.</div> -<dl> -<dt>Default:</dt> -<dd>""</dd> -</dl> -</li> -</ul> -</li> -</ul> -<ul class="blockList"> <li class="blockList"><a name="favicon--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>favicon</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/RestResource.html#line.582">favicon</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/RestResource.html#line.517">favicon</a></pre> <div class="block">The favicon to use for HTML views. <p> - The name is a path to an icon file located in either the classpath or working directory in a similar way to how - the <a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--"><code>stylesheet()</code></a> stylesheet is resolved. + The name is a path to an icon file located in either the classpath or working directory. The resulting favicon becomes available in the servlet via the URL <js>"[servlet-path]/favicon.ico"</js>. <p> @@ -1123,7 +1040,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>staticFiles</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/RestResource.html#line.621">staticFiles</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/RestResource.html#line.556">staticFiles</a></pre> <div class="block">Defines paths and locations of statically served files. <p> @@ -1174,7 +1091,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>clientVersionHeader</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/RestResource.html#line.636">clientVersionHeader</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/RestResource.html#line.571">clientVersionHeader</a></pre> <div class="block">Specifies the HTTP header name used to identify the client version. <p> @@ -1201,7 +1118,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>resourceResolver</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/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.667">resourceResolver</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/rest/RestResourceResolver.html" title="class in org.apache.juneau.rest">RestResourceResolver</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.602">resourceResolver</a></pre> <div class="block">Specifies the resolver class to use for resolving child resources by class name. <p> @@ -1244,7 +1161,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>logger</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/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.680">logger</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/rest/RestLogger.html" title="class in org.apache.juneau.rest">RestLogger</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.615">logger</a></pre> <div class="block">Specifies the logger class to use for logging. <p> @@ -1269,7 +1186,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>callHandler</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/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.693">callHandler</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/rest/RestCallHandler.html" title="class in org.apache.juneau.rest">RestCallHandler</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.628">callHandler</a></pre> <div class="block">Specifies the REST call handler class. <p> @@ -1294,7 +1211,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>infoProvider</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/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.705">infoProvider</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/rest/RestInfoProvider.html" title="class in org.apache.juneau.rest">RestInfoProvider</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.640">infoProvider</a></pre> <div class="block">Specifies the class used to retrieve title/description/swagger information about a resource. <p> @@ -1318,7 +1235,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>serializerListener</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/serializer/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.710">serializerListener</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/serializer/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.645">serializerListener</a></pre> <div class="block">Specifies the serializer listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> @@ -1335,7 +1252,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>parserListener</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/parser/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.715">parserListener</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/parser/ParserListener.html" title="class in org.apache.juneau.parser">ParserListener</a>> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.650">parserListener</a></pre> <div class="block">Specifies the parser listener class to use for listening for non-fatal errors.</div> <dl> <dt>Default:</dt> @@ -1352,7 +1269,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <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/RestResource.html#line.727">widgets</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/rest/widget/Widget.html" title="class in org.apache.juneau.rest.widget">Widget</a>>[] <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.662">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 text. @@ -1376,7 +1293,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockList"> <li class="blockList"> <h4>swagger</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.752">swagger</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/ResourceSwagger.html" title="annotation in org.apache.juneau.rest.annotation">ResourceSwagger</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.687">swagger</a></pre> <div class="block">Provides swagger-specific metadata on this resource. <p> @@ -1413,7 +1330,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <ul class="blockListLast"> <li class="blockList"> <h4>htmldoc</h4> -<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.792">htmldoc</a></pre> +<pre>public abstract <a href="../../../../../org/apache/juneau/rest/annotation/HtmlDoc.html" title="annotation in org.apache.juneau.rest.annotation">HtmlDoc</a> <a href="../../../../../src-html/org/apache/juneau/rest/annotation/RestResource.html#line.727">htmldoc</a></pre> <div class="block">Provides HTML-doc-specific metadata on this method. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/org/apache/juneau/rest/jaxrs/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/jaxrs/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/jaxrs/package-summary.html index ba667c8..5ea77f7 100644 --- a/content/site/apidocs/org/apache/juneau/rest/jaxrs/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/jaxrs/package-summary.html @@ -186,7 +186,6 @@ <li> Default stylesheets for the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> class. <br>It will produce HTML, but it won't contain any styles applied. - <br>However, it's possible to specify your own stylesheet using the <a href="../../../../../org/apache/juneau/html/HtmlDocSerializerContext.html#HTMLDOC_cssUrl"><code>HtmlDocSerializerContext.HTMLDOC_cssUrl</code></a> property. <li> The ability to specify HTTP method, headers, and content using GET parameters. <br>These make debugging REST interfaces using only a browser possible. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html index 0d72e90..12df8ff 100644 --- a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaDefault.html @@ -134,10 +134,10 @@ var activeTableTab = "activeTableTab"; <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/apache/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 h ref="../../../../../org/apache/juneau/plaintext/PlainTextSerializer.html" title="class in org.apache.juneau.plaintext">PlainTextSerializer.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfSerializer.Xml.html" title="class in org.apache.juneau.jena">RdfSerializer.Xml.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfSerializer.XmlAbbrev.html" title="class in org.apache.juneau.jena">RdfSerializer.XmlAbbrev.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfSerializer.N3.html" title="class in org.apache.juneau.jena">RdfSerializer.N3.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfSerializer.NTriple.html" title="class in org.apache.juneau.jena">RdfSerializer.NTriple.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfSerializer.Turtle.html" title="class in org.apache.juneau.jena">RdfSerializer.Turtle.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/jena/RdfParser.Xml.html" title="class in org.apache.juneau. jena">RdfParser.Xml.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfParser.N3.html" title="class in org.apache.juneau.jena">RdfParser.N3.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfParser.NTriple.html" title="class in org.apache.juneau.jena">RdfParser.NTriple.class</a>,<a href="../../../../../org/apache/juneau/jena/RdfParser.Turtle.html" title="class in org.apache.juneau.jena">RdfParser.Turtle.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.ico", - <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/jena/RestServletJenaDefault.html#line.251">RestServletJenaDefault</a> + <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/jena/RestServletJenaDefault.html#line.254">RestServletJenaDefault</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 sets of serializers and parsers that include RDF support. @@ -410,7 +410,7 @@ extends <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title=" <ul class="blockListLast"> <li class="blockList"> <h4>RestServletJenaDefault</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.251">RestServletJenaDefault</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html#line.254">RestServletJenaDefault</a>()</pre> </li> </ul> </li> @@ -432,7 +432,7 @@ extends <a href="../../../../../org/apache/juneau/rest/RestServlet.html" title=" <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>="Resource options", <a href="../../../../../org/apache/juneau/rest/annotation/RestMethod.html#htmldoc--">htmldoc</a>=) -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/jena/RestServletJenaDefault.html#line.267">getOptions</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> req)</pre> +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/jena/RestServletJenaDefault.html#line.270">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/b5c66cf1/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.html b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.html index 9051646..1c6d90e 100644 --- a/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.html +++ b/content/site/apidocs/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.html @@ -130,6 +130,10 @@ var activeTableTab = "activeTableTab"; <dt>All Implemented Interfaces:</dt> <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/Servlet.html?is-external=true"; title="class or interface in javax.servlet">Servlet</a>, <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletConfig.html?is-external=true"; title="class or interface in javax.servlet">ServletConfig</a></dd> </dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/juneau/microservice/ResourceJenaGroup.html" title="class in org.apache.juneau.microservice">ResourceJenaGroup</a></dd> +</dl> <hr> <br> <pre><a href="../../../../../org/apache/juneau/rest/annotation/RestResource.html" title="annotation in org.apache.juneau.rest.annotation">@RestResource</a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/org/apache/juneau/rest/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/package-summary.html b/content/site/apidocs/org/apache/juneau/rest/package-summary.html index 7b3b396..aecc845 100644 --- a/content/site/apidocs/org/apache/juneau/rest/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/rest/package-summary.html @@ -2810,61 +2810,7 @@ <a id="RestResources.Stylesheet"></a> <h3 class='topic' onclick='toggle(this)'>4.17 - Stylesheet</h3> <div class='topic'> - <p> - The <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--"><code>@RestResource.stylesheet()</code></a> annotation - is used to identify the stylesheet to use when rendering POJOs as HTML. - </p> - <p> - The value is a path to a stylesheet located in either the classpath or working directory. - The resulting stylesheet becomes available as a static file through the servlet via the URL - <js>"[servletpath]/style.css"</js>. - </p> - <p> - The default set of styles located in the <l>org.apache.juneau.rest.styles</l> package are: - </p> - <ul class='spaced-list'> - <li> - <l>"styles/devops.css"</l> - Theme based on IBM DevOps look-and-feel. - <li> - <l>"styles/juneau.css"</l> - Theme based on Jazz look-and-feel. - </ul> - <p> - The DevOps look-and-feel is the newer style: - </p> - <img class='bordered' src='doc-files/AddressBook.png'> - <p> - The Juneau look-and-feel is an older style based on the Jazz Framework: - </p> - <img class='bordered' src='doc-files/AddressBook_juneaustyle.png'> - <p> - Stylesheets are first found in the classpath relative to the servlet class. - If the stylesheet cannot be found on the classpath, an attempt to look in the working directory. - </p> - <p> - If the file cannot be located, the request to <l>"[servletpath]/style.css"</l> will return - <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_FOUND"; title="class or interface in javax.servlet.http"><code>HttpServletResponse.SC_NOT_FOUND</code></a>. - </p> - <p> - Custom stylesheets can be defined by specifying your own stylesheet annotation value: - </p> - <p class='bcode'> - <jk>package</jk> com.foo.mypackage; - <ja>@RestResource</ja>( - stylesheet=<js>"mystyles/mycss.css"</js> - ) - <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault { - } - </p> - <p> - In this example, the servlet will attempt to find the <l>mycss.css</l> file in the following ordered - locations: - </p> - <ol> - <li><l>com.foo.mypackage.mystyles</l> package. - <li><l>org.apache.juneau.rest.mystyles</l> package (since <l>RestServletDefault</l> is in - <l>org.apache.juneau.rest</l>). - <li><l>[working-dir]/mystyles</l> directory. - </ol> + TODO </div> <!-- ======================================================================================================== --> @@ -3077,8 +3023,10 @@ </p> <p class='bcode'> <ja>@RestResource</ja>( - <jc>// Get stylesheet from myconfig.cfg, but default to juneau.css if it's not specified</jc> - stylesheet=<js>"$C{MyServlet/stylesheet,styles/juneau.css}"</js>, + <jc>// Get stylesheet from myconfig.cfg, but default to devops.css if it's not specified</jc> + htmldoc=<ja>@HtmlDoc</ja>( + styleImport=<js>"$C{MyServlet/stylesheet,servlet:/styles/devops.css}"</js>, + ) ... ) <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet { @@ -3290,12 +3238,6 @@ </td> </tr> <tr> - <td><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#stylesheet--"><code>stylesheet()</code></a></td> - <td> - Stylesheet is searched for in child-to-parent order. - </td> - </tr> - <tr> <td><a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#favicon--"><code>favicon()</code></a></td> <td> Favicon is searched for in child-to-parent order. @@ -3802,6 +3744,9 @@ // "$C{...}" variables are pulled from the config file.</jc> htmldoc=<ja>@HtmlDoc</ja>( links=<js>"{up:'request:/..', options:'servlet:/?method=OPTIONS', source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/addressbook/AddressBookResource.java'}"</js> + + <jc>// Our stylesheet for the HTML rendition.</jc> + styleImport=<js>"servlet:/styles/devops.css"</js>, ), <jc>// Properties that get applied to all serializers and parsers.</jc> @@ -3826,19 +3771,18 @@ <ja>@Property</ja>(name=<jsf>HTML_uriAnchorText</jsf>, value=<js>"SERVLET_RELATIVE"</js>) }, - <jc>// Our stylesheet for the HTML rendition.</jc> - stylesheet=<js>"styles/devops.css"</js>, - <jc>// Support GZIP encoding on Accept-Encoding header.</jc> encoders=GzipEncoder.<jk>class</jk>, <jc>// Swagger info.</jc> - contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>, - license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>, - version=<js>"2.0"</js>, - termsOfService=<js>"You're on your own."</js>, - tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>, - externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js> + swagger=<ja>@ResourceSwagger</ja>( + contact=<js>"{name:'John Smith',email:'[email protected]'}"</js>, + license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>, + version=<js>"2.0"</js>, + termsOfService=<js>"You're on your own."</js>, + tags=<js>"[{name:'Java',description:'Java utility',externalDocs:{description:'Home page',url:'http://juneau.apache.org'}}]"</js>, + externalDocs=<js>"{description:'Home page',url:'http://juneau.apache.org'}"</js> + ) ) <jk>public class</jk> AddressBookResource <jk>extends</jk> ResourceJena { <jk>private static final long</jk> <jsf>serialVersionUID</jsf> = 1L;
