http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/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 988cc62..77b4298 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestResponse.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestResponse.html @@ -365,7 +365,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSerializerGroup</h4> -<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.123">getSerializerGroup</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer">SerializerGroup</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.124">getSerializerGroup</a>()</pre> <div class="block">Gets the serializer group for the response.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -379,7 +379,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSupportedMediaTypes</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.132">getSupportedMediaTypes</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.133">getSupportedMediaTypes</a>()</pre> <div class="block">Returns the media types that are valid for <code>Accept</code> headers on the request.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -393,7 +393,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getSupportedEncodings</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.142">getSupportedEncodings</a>() +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.143">getSupportedEncodings</a>() throws <a href="../../../../org/apache/juneau/rest/RestServletException.html" title="class in org.apache.juneau.rest">RestServletException</a></pre> <div class="block">Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on the request.</div> <dl> @@ -410,7 +410,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setOutput</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.163">setOutput</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> output)</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.164">setOutput</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> output)</pre> <div class="block">Sets the HTTP output on the response. <p> Calling this method is functionally equivalent to returning the object in the REST Java method. @@ -437,7 +437,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setProperty</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.184">setProperty</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> key, +<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.185">setProperty</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> 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)</pre> <div class="block">Add a serializer property to send to the serializers to override a default value. <p> @@ -463,7 +463,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getProperties</h4> -<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.194">getProperties</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.195">getProperties</a>()</pre> <div class="block">Returns the properties set via <a href="../../../../org/apache/juneau/rest/RestResponse.html#setProperty-java.lang.String-java.lang.Object-"><code>setProperty(String, Object)</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -477,7 +477,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setOutputs</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.213">setOutputs</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>... output)</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.214">setOutputs</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>... output)</pre> <div class="block">Shortcut method that allows you to use varargs to simplify setting array output. <h5 class='section'>Example:</h5> @@ -502,7 +502,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getOutput</h4> -<pre>public <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> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.223">getOutput</a>()</pre> +<pre>public <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> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.224">getOutput</a>()</pre> <div class="block">Returns the output that was set by calling <a href="../../../../org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>setOutput(Object)</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -516,7 +516,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>hasOutput</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.232">hasOutput</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.233">hasOutput</a>()</pre> <div class="block">Returns <jk>true</jk> if this response has any output associated with it.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -530,7 +530,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>sendPlainText</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.243">sendPlainText</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> text) +<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.244">sendPlainText</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> text) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Sets the output to a plain-text message regardless of the content type.</div> <dl> @@ -549,7 +549,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getNegotiatedOutputStream</h4> -<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.257">getNegotiatedOutputStream</a>() +<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.258">getNegotiatedOutputStream</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getOutputStream--"; title="class or interface in javax.servlet"><code>ServletResponse.getOutputStream()</code></a>, except wraps the output stream if an <a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> was found that matched @@ -568,7 +568,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getOutputStream</h4> -<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.308">getOutputStream</a>() +<pre>public <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletOutputStream.html?is-external=true"; title="class or interface in javax.servlet">ServletOutputStream</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.309">getOutputStream</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> @@ -586,7 +586,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getOutputStreamCalled</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.319">getOutputStreamCalled</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.320">getOutputStreamCalled</a>()</pre> <div class="block">Returns <jk>true</jk> if <a href="../../../../org/apache/juneau/rest/RestResponse.html#getOutputStream--"><code>getOutputStream()</code></a> has been called.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -600,7 +600,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getWriter</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.329">getWriter</a>() +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.330">getWriter</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Returns the writer to the response body. This methods bypasses any specified encoders and returns a regular unbuffered writer. @@ -621,7 +621,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getDirectWriter</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.342">getDirectWriter</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> contentType) +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.343">getDirectWriter</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> contentType) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Convenience method meant to be used when rendering directly to a browser with no buffering. Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered @@ -642,7 +642,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getNegotiatedWriter</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.357">getNegotiatedWriter</a>() +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.358">getNegotiatedWriter</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getWriter--"; title="class or interface in javax.servlet"><code>ServletResponse.getWriter()</code></a>, except wraps the output stream if an <a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> was found that matched @@ -662,7 +662,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMediaType</h4> -<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.382">getMediaType</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/MediaType.html" title="class in org.apache.juneau">MediaType</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.383">getMediaType</a>()</pre> <div class="block">Returns the <code>Content-Type</code> header stripped of the charset attribute if present.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -676,7 +676,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>sendRedirect</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.394">sendRedirect</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> uri) +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.395">sendRedirect</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> uri) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block">Redirects to the specified URI. <p> @@ -699,7 +699,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getUrlEncodingSerializer</h4> -<pre>public <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.406">getUrlEncodingSerializer</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.407">getUrlEncodingSerializer</a>()</pre> <div class="block">Returns the URL-encoding serializer associated with this response.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -713,7 +713,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setHeader</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.411">setHeader</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.412">setHeader</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -729,7 +729,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setPageTitle</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.436">setPageTitle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> title)</pre> +<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.437">setPageTitle</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> title)</pre> <div class="block">Sets the page title for HTML views. <p> This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageTitle--"><code>@RestResource#pageTitle()</code></a>/ @@ -755,7 +755,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>setPageText</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.455">setPageText</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> text)</pre> +<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.456">setPageText</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> text)</pre> <div class="block">Sets the page text for HTML views. <p> This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageText--"><code>@RestResource#pageText()</code></a>/ @@ -780,7 +780,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockListLast"> <li class="blockList"> <h4>setPageLinks</h4> -<pre>public <a href="../../../../org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest">RestResponse</a> <a href="../../../../src-html/org/apache/juneau/rest/RestResponse.html#line.474">setPageLinks</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> links)</pre> +<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.475">setPageLinks</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> links)</pre> <div class="block">Sets the page text for HTML views. <p> This is the programmatic equivalent to the <a href="../../../../org/apache/juneau/rest/annotation/RestResource.html#pageLinks--"><code>@RestResource#pageLinks()</code></a>/
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/org/apache/juneau/rest/RestServlet.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestServlet.html b/content/site/apidocs/org/apache/juneau/rest/RestServlet.html index 393a35f..61e521f 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestServlet.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestServlet.html @@ -580,7 +580,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getMessages</h4> -<pre>public <a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.261">getMessages</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/utils/MessageBundle.html" title="class in org.apache.juneau.utils">MessageBundle</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.262">getMessages</a>()</pre> <div class="block">Convenience method for calling <code>getContext().getMessages();</code></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -596,7 +596,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockList"> <li class="blockList"> <h4>getProperties</h4> -<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.270">getProperties</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.271">getProperties</a>()</pre> <div class="block">Convenience method for calling <code>getContext().getProperties();</code></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -612,7 +612,7 @@ extends <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServ <ul class="blockListLast"> <li class="blockList"> <h4>getBeanContext</h4> -<pre>public <a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.279">getBeanContext</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a> <a href="../../../../src-html/org/apache/juneau/rest/RestServlet.html#line.280">getBeanContext</a>()</pre> <div class="block">Convenience method for calling <code>getContext().getBeanContext();</code></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/org/apache/juneau/rest/RestUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RestUtils.html b/content/site/apidocs/org/apache/juneau/rest/RestUtils.html index ab33041..ea2627c 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RestUtils.html +++ b/content/site/apidocs/org/apache/juneau/rest/RestUtils.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9}; +var methods = {"i0":9,"i1":9,"i2":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.27">RestUtils</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.24">RestUtils</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Various reusable utility methods.</div> </li> @@ -148,29 +148,17 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>static <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/RestUtils.html#decode-java.lang.String-">decode</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> s)</code> -<div class="block">Decodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>static <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/RestUtils.html#encode-java.lang.String-">encode</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> s)</code> -<div class="block">Encodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>static <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/RestUtils.html#getHttpResponseText-int-">getHttpResponseText</a></span>(int rc)</code> <div class="block">Returns readable text for an HTTP response code.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i1" class="rowColor"> <td class="colFirst"><code>static <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/RestUtils.html#getPathInfoUndecoded-javax.servlet.http.HttpServletRequest-">getPathInfoUndecoded</a></span>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req)</code> <div class="block">Identical to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequest.getPathInfo()</code></a> but doesn't decode encoded characters.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestUtils.html#trimPathInfo-java.lang.StringBuffer-java.lang.String-java.lang.String-">trimPathInfo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> requestURI, <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> contextPath, @@ -178,24 +166,6 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <div class="block">Efficiently trims the path info part from a request URI.</div> </td> </tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>static <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/RestUtils.html#trimSlashes-java.lang.String-">trimSlashes</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> s)</code> -<div class="block">Trims <js>'/'</js> characters from both the start and end of the specified string.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>static <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/RestUtils.html#trimTrailingSlashes-java.lang.String-">trimTrailingSlashes</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> s)</code> -<div class="block">Trims <js>'/'</js> characters from the end of the specified string.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RestUtils.html#trimTrailingSlashes-java.lang.StringBuffer-">trimTrailingSlashes</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> s)</code> -<div class="block">Trims <js>'/'</js> characters from the end of the specified string.</div> -</td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> @@ -224,7 +194,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>RestUtils</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.27">RestUtils</a>()</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.24">RestUtils</a>()</pre> </li> </ul> </li> @@ -241,7 +211,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getHttpResponseText</h4> -<pre>public static <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/RestUtils.html#line.35">getHttpResponseText</a>(int rc)</pre> +<pre>public static <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/RestUtils.html#line.32">getHttpResponseText</a>(int rc)</pre> <div class="block">Returns readable text for an HTTP response code.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -251,93 +221,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </dl> </li> </ul> -<a name="trimSlashes-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>trimSlashes</h4> -<pre>public static <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/RestUtils.html#line.84">trimSlashes</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> s)</pre> -<div class="block">Trims <js>'/'</js> characters from both the start and end of the specified string.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The string to trim.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A new trimmed string, or the same string if no trimming was necessary.</dd> -</dl> -</li> -</ul> -<a name="trimTrailingSlashes-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>trimTrailingSlashes</h4> -<pre>public static <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/RestUtils.html#line.100">trimTrailingSlashes</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> s)</pre> -<div class="block">Trims <js>'/'</js> characters from the end of the specified string.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The string to trim.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A new trimmed string, or the same string if no trimming was necessary.</dd> -</dl> -</li> -</ul> -<a name="trimTrailingSlashes-java.lang.StringBuffer-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>trimTrailingSlashes</h4> -<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.114">trimTrailingSlashes</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> s)</pre> -<div class="block">Trims <js>'/'</js> characters from the end of the specified string.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The string to trim.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The same string buffer.</dd> -</dl> -</li> -</ul> -<a name="decode-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>decode</h4> -<pre>public static <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/RestUtils.html#line.128">decode</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> s)</pre> -<div class="block">Decodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The string to decode.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The decoded string, or <jk>null</jk> if input is <jk>null</jk>.</dd> -</dl> -</li> -</ul> -<a name="encode-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>encode</h4> -<pre>public static <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/RestUtils.html#line.153">encode</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> s)</pre> -<div class="block">Encodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>s</code> - The string to encode.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The encoded string, or <jk>null</jk> if input is <jk>null</jk>.</dd> -</dl> -</li> -</ul> <a name="getPathInfoUndecoded-javax.servlet.http.HttpServletRequest-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPathInfoUndecoded</h4> -<pre>public static <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/RestUtils.html#line.172">getPathInfoUndecoded</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req)</pre> +<pre>public static <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/RestUtils.html#line.81">getPathInfoUndecoded</a>(<a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true"; title="class or interface in javax.servlet.http">HttpServletRequest</a> req)</pre> <div class="block">Identical to <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getPathInfo--"; title="class or interface in javax.servlet.http"><code>HttpServletRequest.getPathInfo()</code></a> but doesn't decode encoded characters.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -353,7 +243,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>trimPathInfo</h4> -<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.192">trimPathInfo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> requestURI, +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> <a href="../../../../src-html/org/apache/juneau/rest/RestUtils.html#line.101">trimPathInfo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true"; title="class or interface in java.lang">StringBuffer</a> requestURI, <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> contextPath, <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> servletPath)</pre> <div class="block">Efficiently trims the path info part from a request URI. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html b/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html index 6827920..d97d4a0 100644 --- a/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html +++ b/content/site/apidocs/org/apache/juneau/rest/UrlPathPattern.html @@ -112,7 +112,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.28">UrlPathPattern</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.27">UrlPathPattern</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest">UrlPathPattern</a>></pre> <div class="block">A parsed path pattern constructed from a <a href="../../../../org/apache/juneau/rest/annotation/RestMethod.html#path--"><code>RestMethod.path()</code></a> value. @@ -225,7 +225,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockListLast"> <li class="blockList"> <h4>UrlPathPattern</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.40">UrlPathPattern</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> patternString)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.39">UrlPathPattern</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> patternString)</pre> <div class="block">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -247,7 +247,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>match</h4> -<pre>protected <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/UrlPathPattern.html#line.85">match</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> path)</pre> +<pre>protected <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/UrlPathPattern.html#line.84">match</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> path)</pre> <div class="block">Returns a non-<jk>null</jk> value if the specified path matches this pattern.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -265,7 +265,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>compareTo</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.130">compareTo</a>(<a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest">UrlPathPattern</a> o)</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.129">compareTo</a>(<a href="../../../../org/apache/juneau/rest/UrlPathPattern.html" title="class in org.apache.juneau.rest">UrlPathPattern</a> o)</pre> <div class="block">Comparator for this object. The comparator is designed to order URL pattern from most-specific to least-specific. For example, the following patterns would be ordered as follows: @@ -291,7 +291,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>equals</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.148">equals</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> o)</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.147">equals</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> o)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a></code> in class <code><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></code></dd> @@ -304,7 +304,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> -<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.155">hashCode</a>()</pre> +<pre>public int <a href="../../../../src-html/org/apache/juneau/rest/UrlPathPattern.html#line.154">hashCode</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a></code> in class <code><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></code></dd> @@ -317,7 +317,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>toString</h4> -<pre>public <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/UrlPathPattern.html#line.160">toString</a>()</pre> +<pre>public <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/UrlPathPattern.html#line.159">toString</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><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">toString</a></code> in class <code><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></code></dd> @@ -330,7 +330,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>toRegEx</h4> -<pre>public <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/UrlPathPattern.html#line.170">toRegEx</a>()</pre> +<pre>public <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/UrlPathPattern.html#line.169">toRegEx</a>()</pre> <div class="block">Returns this path pattern as the compiled regular expression. Useful for debugging.</div> <dl> @@ -345,7 +345,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>getVars</h4> -<pre>public <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/UrlPathPattern.html#line.178">getVars</a>()</pre> +<pre>public <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/UrlPathPattern.html#line.177">getVars</a>()</pre> <div class="block">Bean property getter: <property>vars</property>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -359,7 +359,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparabl <ul class="blockListLast"> <li class="blockList"> <h4>getPatternString</h4> -<pre>public <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/UrlPathPattern.html#line.186">getPatternString</a>()</pre> +<pre>public <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/UrlPathPattern.html#line.185">getPatternString</a>()</pre> <div class="block">Bean property getter: <property>patternString</property>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html index 6e9e573..9d87cad 100644 --- a/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html +++ b/content/site/apidocs/org/apache/juneau/rest/annotation/RestMethod.html @@ -319,7 +319,7 @@ public @interface <a href="../../../../../src-html/org/apache/juneau/rest/annota <br>For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected as <js>"POST"</js>. <br>Otherwise, defaults to <js>"GET"</js>. <li><js>"PROXY"</js> - Remote-proxy interface. - <br>This denotes a Java method that returns an object (usually an interface, often annotated with the <a href="../../../../../org/apache/juneau/annotation/Remoteable.html" title="annotation in org.apache.juneau.annotation"><code>@Remoteable</code></a> annotation) + <br>This denotes a Java method that returns an object (usually an interface, often annotated with the <a href="../../../../../org/apache/juneau/remoteable/Remoteable.html" title="annotation in org.apache.juneau.remoteable"><code>@Remoteable</code></a> annotation) to be used as a remote proxy using <code>RestClient.getRemoteableProxy(Class<T> interfaceClass, String url)</code>. <br>This allows you to construct client-side interface proxies using REST as a transport medium. <br>Conceptually, this is simply a fancy <code>POST</code> against the url <js>"/{path}/{javaMethodName}"</js> where the arguments http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html b/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html index 0a502d6..c757ee5 100644 --- a/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html +++ b/content/site/apidocs/org/apache/juneau/rest/client/NameValuePairs.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -132,17 +132,20 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public final class <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.32">NameValuePairs</a> +<pre>public final class <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.38">NameValuePairs</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.html?is-external=true"; title="class or interface in java.util">LinkedList</a><org.apache.http.NameValuePair></pre> <div class="block">Convenience class for constructing instances of <code>List<NameValuePair></code> for the <code>UrlEncodedFormEntity</code> class. + <p> + Instances of this method can be passed directly to the <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#doPost-java.lang.Object-java.lang.Object-"><code>RestClient.doPost(Object, Object)</code></a> method or + <a href="../../../../../org/apache/juneau/rest/client/RestCall.html#input-java.lang.Object-"><code>RestCall.input(Object)</code></a> methods to perform URL-encoded form posts. <h5 class='section'>Example:</h5> <p class='bcode'> NameValuePairs params = <jk>new</jk> NameValuePairs() - .append(<jk>new</jk> BasicNameValuePair(<js>"j_username"</js>, user)) - .append(<jk>new</jk> BasicNameValuePair(<js>"j_password"</js>, pw)); - request.setEntity(<jk>new</jk> UrlEncodedFormEntity(params)); + .append(<js>"j_username"</js>, user) + .append(<js>"j_password"</js>, pw); + restClient.doPost(url, params).run(); </p></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -204,6 +207,21 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <div class="block">Appends the specified pair to the end of this list.</div> </td> </tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html" title="class in org.apache.juneau.rest.client">NameValuePairs</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html#append-java.lang.String-java.lang.Object-">append</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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Appends the specified name/value pair to the end of this list.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html" title="class in org.apache.juneau.rest.client">NameValuePairs</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html#append-java.lang.String-java.lang.Object-org.apache.juneau.urlencoding.UrlEncodingSerializer-">append</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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + <a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> serializer)</code> +<div class="block">Appends the specified name/value pair to the end of this list.</div> +</td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.util.LinkedList"> @@ -288,7 +306,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <ul class="blockListLast"> <li class="blockList"> <h4>NameValuePairs</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.32">NameValuePairs</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.38">NameValuePairs</a>()</pre> </li> </ul> </li> @@ -302,10 +320,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <a name="append-org.apache.http.NameValuePair-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>append</h4> -<pre>public <a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html" title="class in org.apache.juneau.rest.client">NameValuePairs</a> <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.42">append</a>(org.apache.http.NameValuePair pair)</pre> +<pre>public <a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html" title="class in org.apache.juneau.rest.client">NameValuePairs</a> <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.48">append</a>(org.apache.http.NameValuePair pair)</pre> <div class="block">Appends the specified pair to the end of this list.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -315,6 +333,49 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h </dl> </li> </ul> +<a name="append-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html" title="class in org.apache.juneau.rest.client">NameValuePairs</a> <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.62">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Appends the specified name/value pair to the end of this list. + <p> + The value is simply converted to a string using <code>toString()</code>, or <js>"null"</js> if <jk>null</jk>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The pair name.</dd> +<dd><code>value</code> - The pair value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="append-java.lang.String-java.lang.Object-org.apache.juneau.urlencoding.UrlEncodingSerializer-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../../org/apache/juneau/rest/client/NameValuePairs.html" title="class in org.apache.juneau.rest.client">NameValuePairs</a> <a href="../../../../../src-html/org/apache/juneau/rest/client/NameValuePairs.html#line.78">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value, + <a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding">UrlEncodingSerializer</a> serializer)</pre> +<div class="block">Appends the specified name/value pair to the end of this list. + <p> + The value is converted to UON notation using the <a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html#serializePart-java.lang.Object-java.lang.Boolean-java.lang.Boolean-"><code>UrlEncodingSerializer.serializePart(Object, Boolean, Boolean)</code></a> method + of the specified serializer.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The pair name.</dd> +<dd><code>value</code> - The pair value.</dd> +<dd><code>serializer</code> - The serializer to use to convert the value to a string.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> </li> </ul> </li>
