http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/org/apache/juneau/rest/RequestBody.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RequestBody.html b/content/site/apidocs/org/apache/juneau/rest/RequestBody.html index ccb5625..501f620 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RequestBody.html +++ b/content/site/apidocs/org/apache/juneau/rest/RequestBody.html @@ -229,10 +229,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> <div class="block">Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO. <p> - If <code>allowHeaderParams</code> init parameter is <jk>true</jk>, then first looks for <code>&body=xxx</code> in the URL + If <code>allowHeaderParams</code> init parameter is <jk>true</jk>, then first looks for <code>&body=xxx</code> in the URL query string. <p> - If type is <jk>null</jk> or <code>Object.<jk>class</jk></code>, then the actual type will be determined + If type is <jk>null</jk> or <code>Object.<jk>class</jk></code>, then the actual type will be determined automatically based on the following input: <table class='styled'> <tr><th>Type</th><th>JSON input</th><th>XML input</th><th>Return type</th></tr> @@ -274,25 +274,25 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </tr> </table> <p> - Refer to <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a> for + Refer to <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a> for a complete definition of supported POJOs. <p> <h5 class='section'>Examples:</h5> <p class='bcode'> <jc>// Parse into an integer.</jc> - <jk>int</jk> body = req.getBody(<jk>int</jk>.<jk>class</jk>); + <jk>int</jk> body = req.getBody().asType(<jk>int</jk>.<jk>class</jk>); <jc>// Parse into an int array.</jc> - <jk>int</jk>[] body = req.getBody(<jk>int</jk>[].<jk>class</jk>); + <jk>int</jk>[] body = req.getBody().asType(<jk>int</jk>[].<jk>class</jk>); <jc>// Parse into a bean.</jc> - MyBean body = req.getBody(MyBean.<jk>class</jk>); + MyBean body = req.getBody().asType(MyBean.<jk>class</jk>); <jc>// Parse into a linked-list of objects.</jc> - List body = req.getBody(LinkedList.<jk>class</jk>); + List body = req.getBody().asType(LinkedList.<jk>class</jk>); <jc>// Parse into a map of object keys/values.</jc> - Map body = req.getBody(TreeMap.<jk>class</jk>); + Map body = req.getBody().asType(TreeMap.<jk>class</jk>); </p></div> <dl> <dt><span class="paramLabel">Type Parameters:</span></dt> @@ -303,7 +303,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <dd>The input parsed to a POJO.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><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></code> - If a problem occurred trying to read from the reader.</dd> -<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code> - If the input contains a syntax error or is malformed for the requested <code>Accept</code> +<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code> - If the input contains a syntax error or is malformed for the requested <code>Accept</code> header or is not valid for the specified type.</dd> </dl> </li> @@ -321,26 +321,26 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <h5 class='section'>Examples:</h5> <p class='bcode'> <jc>// Parse into a linked-list of strings.</jc> - List<String> body = req.getBody(LinkedList.<jk>class</jk>, String.<jk>class</jk>); + List<String> body = req.getBody().asType(LinkedList.<jk>class</jk>, String.<jk>class</jk>); <jc>// Parse into a linked-list of linked-lists of strings.</jc> - List<List<String>> body = req.getBody(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>); + List<List<String>> body = req.getBody().asType(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>); <jc>// Parse into a map of string keys/values.</jc> - Map<String,String> body = req.getBody(TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>); + Map<String,String> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>); <jc>// Parse into a map containing string keys and values of lists containing beans.</jc> - Map<String,List<MyBean>> body = req.getBody(TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>); + Map<String,List<MyBean>> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>); </p></div> <dl> <dt><span class="paramLabel">Type Parameters:</span></dt> <dd><code>T</code> - The class type to instantiate.</dd> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>type</code> - The type of object to create. - <br>Can be any of the following: <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></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"><code>Class</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/ParameterizedType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>ParameterizedType</code></a>, + <br>Can be any of the following: <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></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"><code>Class</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/ParameterizedType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>ParameterizedType</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/GenericArrayType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>GenericArrayType</code></a></dd> <dd><code>args</code> - The type arguments of the class if it's a collection or map. - <br>Can be any of the following: <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></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"><code>Class</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/ParameterizedType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>ParameterizedType</code></a>, + <br>Can be any of the following: <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></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"><code>Class</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/ParameterizedType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>ParameterizedType</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/GenericArrayType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>GenericArrayType</code></a> <br>Ignored if the main type is not a map or collection.</dd> <dt><span class="returnLabel">Returns:</span></dt> @@ -358,7 +358,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? 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 HTTP body content as a plain string. <p> - If <code>allowHeaderParams</code> init parameter is true, then first looks for <code>&body=xxx</code> in the URL query + If <code>allowHeaderParams</code> init parameter is true, then first looks for <code>&body=xxx</code> in the URL query string.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -395,7 +395,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? 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 HTTP body content as a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a>. <p> - If <code>allowHeaderParams</code> init parameter is true, then first looks for <code>&body=xxx</code> in the URL query + If <code>allowHeaderParams</code> init parameter is true, then first looks for <code>&body=xxx</code> in the URL query string. <p> Automatically handles GZipped input streams.</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/org/apache/juneau/rest/RequestFormData.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RequestFormData.html b/content/site/apidocs/org/apache/juneau/rest/RequestFormData.html index 94b1bfe..0fb6ae1 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RequestFormData.html +++ b/content/site/apidocs/org/apache/juneau/rest/RequestFormData.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}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -185,6 +185,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest">RequestFormData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#addDefault-java.util.Map-">addDefault</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> defaultEntries)</code> +<div class="block">Adds default entries to these form-data parameters.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> <td class="colFirst"><code><T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#get-java.lang.String-java.lang.Class-">get</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> @@ -192,7 +198,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingParser</code></a> registered with this servlet.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code><T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#get-java.lang.String-T-java.lang.Class-">get</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, T def, @@ -200,7 +206,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RequestFormData.html#get-java.lang.String-java.lang.Class-"><code>get(String, Class)</code></a> except returns a default value if not specified.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code><T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#get-java.lang.String-java.lang.reflect.Type-java.lang.reflect.Type...-">get</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/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a> type, @@ -209,7 +215,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <a href="../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingParser</code></a> registered with this servlet.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code><T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#getAll-java.lang.String-java.lang.Class-">getAll</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> @@ -217,7 +223,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa (e.g.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code><T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#getAll-java.lang.String-java.lang.reflect.Type-java.lang.reflect.Type...-">getAll</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/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a> type, @@ -226,20 +232,20 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa (e.g.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" 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/RequestFormData.html#getFirst-java.lang.String-">getFirst</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)</code> <div class="block">Returns a form data parameter value.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" 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/RequestFormData.html#getFirst-java.lang.String-java.lang.String-">getFirst</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/String.html?is-external=true"; title="class or interface in java.lang">String</a> def)</code> <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RequestFormData.html#getFirst-java.lang.String-"><code>getFirst(String)</code></a> except returns a default value if <jk>null</jk> or empty.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestFormData.html#put-java.lang.String-java.lang.Object-">put</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> @@ -313,13 +319,31 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <!-- --> </a> <h3>Method Detail</h3> +<a name="addDefault-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDefault</h4> +<pre>public <a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest">RequestFormData</a> <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.51">addDefault</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> defaultEntries)</pre> +<div class="block">Adds default entries to these form-data parameters. + <p> + This includes the default form-data parameters defined on the servlet and method levels.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>defaultEntries</code> - The default entries. Can be <jk>null</jk>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> <a name="put-java.lang.String-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>put</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.49">put</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/RequestFormData.html#line.69">put</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">Sets a request form data parameter value.</div> <dl> @@ -335,7 +359,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>getFirst</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/RequestFormData.html#line.74">getFirst</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<pre>public <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/RequestFormData.html#line.94">getFirst</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> <div class="block">Returns a form data parameter value. <p> Parameter lookup is case-insensitive (consistent with WAS, but differs from Tomcat). @@ -366,7 +390,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>getFirst</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/RequestFormData.html#line.95">getFirst</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="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/RequestFormData.html#line.115">getFirst</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> def)</pre> <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RequestFormData.html#getFirst-java.lang.String-"><code>getFirst(String)</code></a> except returns a default value if <jk>null</jk> or empty.</div> <dl> @@ -384,7 +408,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.135">get</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 <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.155">get</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type) throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> <div class="block">Returns the specified form data parameter value converted to a POJO using the @@ -433,7 +457,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.149">get</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 <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.169">get</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, T def, <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><T> type) throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> @@ -458,7 +482,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>getAll</h4> -<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.164">getAll</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 <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.184">getAll</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type) throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> <div class="block">Same as <a href="../../../../org/apache/juneau/rest/RequestFormData.html#get-java.lang.String-java.lang.Class-"><code>get(String, Class)</code></a> except for use on multi-part parameters @@ -482,7 +506,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.202">get</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 <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.222">get</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/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a> type, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a>... args) throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> @@ -530,7 +554,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockListLast"> <li class="blockList"> <h4>getAll</h4> -<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.221">getAll</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 <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestFormData.html#line.241">getAll</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/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a> type, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a>... args) throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/org/apache/juneau/rest/RequestHeaders.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RequestHeaders.html b/content/site/apidocs/org/apache/juneau/rest/RequestHeaders.html index 319426d..52bb2d1 100644 --- a/content/site/apidocs/org/apache/juneau/rest/RequestHeaders.html +++ b/content/site/apidocs/org/apache/juneau/rest/RequestHeaders.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/rest/RequestPathParams.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/RequestPathMatch.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/rest/RequestHeaders.html" target="_top">Frames</a></li> @@ -1259,7 +1259,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/juneau/rest/RequestFormData.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/juneau/rest/RequestPathParams.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/RequestPathMatch.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/juneau/rest/RequestHeaders.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/0c968486/content/site/apidocs/org/apache/juneau/rest/RequestPathMatch.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/rest/RequestPathMatch.html b/content/site/apidocs/org/apache/juneau/rest/RequestPathMatch.html new file mode 100644 index 0000000..2919730 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/rest/RequestPathMatch.html @@ -0,0 +1,498 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RequestPathMatch (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="RequestPathMatch (Apache Juneau (incubating) 6.2.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/rest/RequestPathMatch.html" target="_top">Frames</a></li> +<li><a href="RequestPathMatch.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.java.util.AbstractMap">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juneau.rest</div> +<h2 title="Class RequestPathMatch" class="title">Class RequestPathMatch</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true"; title="class or interface in java.util">java.util.AbstractMap</a><K,V></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true"; title="class or interface in java.util">java.util.TreeMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.rest.RequestPathMatch</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<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/javase/7/docs/api/java/lang/Cloneable.html?is-external=true"; title="class or interface in java.lang">Cloneable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/NavigableMap.html?is-external=true"; title="class or interface in java.util">NavigableMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interfac e in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true"; title="class or interface in java.util">SortedMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></dd> +</dl> +<hr> +<br> +<pre>public class <a href="../../../../src-html/org/apache/juneau/rest/RequestPathMatch.html#line.30">RequestPathMatch</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true"; title="class or interface in java.util">TreeMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></pre> +<div class="block">Contains information about the matched path on the HTTP request. + <p> + Provides access to the matched path variables and path match remainder.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.juneau.rest.RequestPathMatch">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true"; title="class or interface in java.util">AbstractMap</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.SimpleEntry.html?is-external=true"; title="class or interface in java.util">AbstractMap.SimpleEntry</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.SimpleEntry.html?is-external=true"; title="class or interface in java.util">K</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.SimpleEntry.html?is-external=true"; title="class or interface in java.util">V</a>>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.SimpleImmutableEntry.html?is-external=true"; title="class or interface in java.util">AbstractMap.SimpleImmutableEntry</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.SimpleImmutableEntry.html?is-external=true"; title="class or interface in java.util">K</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.SimpleImmutableEntry.html?is-external=true"; title="class or interface in java.util">V</a>></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestPathMatch.html#get-java.lang.String-java.lang.Class-">get</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> +<div class="block">Returns the specified path parameter converted to a POJO.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestPathMatch.html#get-java.lang.String-java.lang.reflect.Type-java.lang.reflect.Type...-">get</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/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a> type, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a>... args)</code> +<div class="block">Returns the specified path parameter converted to a POJO.</div> +</td> +</tr> +<tr id="i2" 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/RequestPathMatch.html#getRemainder--">getRemainder</a></span>()</code> +<div class="block">Returns the decoded remainder of the URL following any path pattern matches.</div> +</td> +</tr> +<tr id="i3" 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/RequestPathMatch.html#getRemainderUndecoded--">getRemainderUndecoded</a></span>()</code> +<div class="block">Same as <a href="../../../../org/apache/juneau/rest/RequestPathMatch.html#getRemainder--"><code>getRemainder()</code></a> but doesn't decode characters.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/rest/RequestPathMatch.html#put-java.lang.String-java.lang.Object-">put</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">Sets a request query parameter value.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.TreeMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true"; title="class or interface in java.util">TreeMap</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#ceilingEntry-K-"; title="class or interface in java.util">ceilingEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#ceilingKey-K-"; title="class or interface in java.util">ceilingKey</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#clear--"; title="class or interface in java.util">clear</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#clone--"; title="class or interface in java.util">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#comparator--"; title="class or interface in java.util">comparator</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#containsKey-java.lang.Object-"; title="class or interface in java.util">containsKey</a>, <a href="http://docs.oracle .com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#containsValue-java.lang.Object-" title="class or interface in java.util">containsValue</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#descendingKeySet--"; title="class or interface in java.util">descendingKeySet</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#descendingMap--"; title="class or interface in java.util">descendingMap</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#entrySet--"; title="class or interface in java.util">entrySet</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#firstEntry--"; title="class or interface in java.util">firstEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#firstKey--"; title="class or interface in java.util">firstKey</a>, <a href="http://docs.oracle.com/ javase/7/docs/api/java/util/TreeMap.html?is-external=true#floorEntry-K-" title="class or interface in java.util">floorEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#floorKey-K-"; title="class or interface in java.util">floorKey</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#forEach-java.util.function.BiConsumer-"; title="class or interface in java.util">forEach</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#get-java.lang.Object-"; title="class or interface in java.util">get</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#headMap-K-"; title="class or interface in java.util">headMap</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#headMap-K-boolean-"; title="class or interface in java.util">headMap</a>, <a href="http://docs.oracle.com/javase/7/docs/ap i/java/util/TreeMap.html?is-external=true#higherEntry-K-" title="class or interface in java.util">higherEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#higherKey-K-"; title="class or interface in java.util">higherKey</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#keySet--"; title="class or interface in java.util">keySet</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#lastEntry--"; title="class or interface in java.util">lastEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#lastKey--"; title="class or interface in java.util">lastKey</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#lowerEntry-K-"; title="class or interface in java.util">lowerEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#lowerKey -K-" title="class or interface in java.util">lowerKey</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#navigableKeySet--"; title="class or interface in java.util">navigableKeySet</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#pollFirstEntry--"; title="class or interface in java.util">pollFirstEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#pollLastEntry--"; title="class or interface in java.util">pollLastEntry</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#put-K-V-"; title="class or interface in java.util">put</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#putAll-java.util.Map-"; title="class or interface in java.util">putAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#remove-java.lang.Object-"; titl e="class or interface in java.util">remove</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#replace-K-V-"; title="class or interface in java.util">replace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#replace-K-V-V-"; title="class or interface in java.util">replace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#replaceAll-java.util.function.BiFunction-"; title="class or interface in java.util">replaceAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#size--"; title="class or interface in java.util">size</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#subMap-K-boolean-K-boolean-"; title="class or interface in java.util">subMap</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#subMap-K-K-"; title="class or interf ace in java.util">subMap</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#tailMap-K-"; title="class or interface in java.util">tailMap</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#tailMap-K-boolean-"; title="class or interface in java.util">tailMap</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/TreeMap.html?is-external=true#values--"; title="class or interface in java.util">values</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true"; title="class or interface in java.util">AbstractMap</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.util">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true#hashCode--"; title="class or interface in java.util">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true#isEmpty--"; title="class or interface in java.util">isEmpty</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/AbstractMap.html?is-external=true#toString--"; title="class or interface in java.util">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--"; title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is- external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#compute-K-java.util.function.BiFunction-"; title="class or interface in java.util">compute</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#computeIfAbsent-K-java.util.function.Function-"; title="class or interface in java.util">computeIfAbsent</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#computeIfPresent-K-java.util.function.BiFunction-"; title="class or interface in java.util">computeIfPresent</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.util">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#getOrDefault-java.lang.Object-V-"; title="class or interface in java.util">getOrDefault</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-ex ternal=true#hashCode--" title="class or interface in java.util">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#isEmpty--"; title="class or interface in java.util">isEmpty</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#merge-K-V-java.util.function.BiFunction-"; title="class or interface in java.util">merge</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#putIfAbsent-K-V-"; title="class or interface in java.util">putIfAbsent</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#remove-java.lang.Object-java.lang.Object-"; title="class or interface in java.util">remove</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="put-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RequestPathMatch.html#line.62">put</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">Sets a request query parameter value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The parameter name.</dd> +<dd><code>value</code> - The parameter value.</dd> +</dl> +</li> +</ul> +<a name="get-java.lang.String-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestPathMatch.html#line.96">get</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/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type) + throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> +<div class="block">Returns the specified path parameter converted to a POJO. + <p> + The type can be any POJO type convertable from a <code>String</code> (See <a class="doclink" + href="package-summary.html#PojosConvertableFromString">POJOs Convertable From Strings</a>). + <p> + <h5 class='section'>Examples:</h5> + <p class='bcode'> + <jc>// Parse into an integer.</jc> + <jk>int</jk> myparam = req.getPathParameter(<js>"myparam"</js>, <jk>int</jk>.<jk>class</jk>); + + <jc>// Parse into an int array.</jc> + <jk>int</jk>[] myparam = req.getPathParameter(<js>"myparam"</js>, <jk>int</jk>[].<jk>class</jk>); + + <jc>// Parse into a bean.</jc> + MyBean myparam = req.getPathParameter(<js>"myparam"</js>, MyBean.<jk>class</jk>); + + <jc>// Parse into a linked-list of objects.</jc> + List myparam = req.getPathParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>); + + <jc>// Parse into a map of object keys/values.</jc> + Map myparam = req.getPathParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>); + </p></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - The class type to convert the attribute value to.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The attribute name.</dd> +<dd><code>type</code> - The class type to convert the attribute value to.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The attribute value converted to the specified class type.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code></dd> +</dl> +</li> +</ul> +<a name="get-java.lang.String-java.lang.reflect.Type-java.lang.reflect.Type...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/rest/RequestPathMatch.html#line.132">get</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/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a> type, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Type.html?is-external=true"; title="class or interface in java.lang.reflect">Type</a>... args) + throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre> +<div class="block">Returns the specified path parameter converted to a POJO. + <p> + The type can be any POJO type convertable from a <code>String</code> (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertable From Strings</a>). + <p> + Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object. + <p> + <h5 class='section'>Examples:</h5> + <p class='bcode'> + <jc>// Parse into a linked-list of strings.</jc> + List<String> myparam = req.getPathParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>); + + <jc>// Parse into a linked-list of linked-lists of strings.</jc> + List<List<String>> myparam = req.getPathParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>); + + <jc>// Parse into a map of string keys/values.</jc> + Map<String,String> myparam = req.getPathParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>); + + <jc>// Parse into a map containing string keys and values of lists containing beans.</jc> + Map<String,List<MyBean>> myparam = req.getPathParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>); + </p></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - The class type to convert the attribute value to.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The attribute name.</dd> +<dd><code>type</code> - The type of object to create. + <br>Can be any of the following: <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></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"><code>Class</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/ParameterizedType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>ParameterizedType</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/GenericArrayType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>GenericArrayType</code></a></dd> +<dd><code>args</code> - The type arguments of the class if it's a collection or map. + <br>Can be any of the following: <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></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"><code>Class</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/ParameterizedType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>ParameterizedType</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/GenericArrayType.html?is-external=true"; title="class or interface in java.lang.reflect"><code>GenericArrayType</code></a> + <br>Ignored if the main type is not a map or collection.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The attribute value converted to the specified class type.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code></dd> +</dl> +</li> +</ul> +<a name="getRemainder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainder</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/RequestPathMatch.html#line.201">getRemainder</a>()</pre> +<div class="block">Returns the decoded remainder of the URL following any path pattern matches. + <p> + The behavior of path remainder is shown below given the path pattern "/foo/*": + <p> + <table class='styled'> + <tr> + <th>URL</th> + <th>Path Remainder</th> + </tr> + <tr> + <td><code>/foo</code></td> + <td><jk>null</jk></td> + </tr> + <tr> + <td><code>/foo/</code></td> + <td><js>""</js></td> + </tr> + <tr> + <td><code>/foo//</code></td> + <td><js>"/"</js></td> + </tr> + <tr> + <td><code>/foo///</code></td> + <td><js>"//"</js></td> + </tr> + <tr> + <td><code>/foo/a/b</code></td> + <td><js>"a/b"</js></td> + </tr> + <tr> + <td><code>/foo//a/b/</code></td> + <td><js>"/a/b/"</js></td> + </tr> + <tr> + <td><code>/foo/a%2Fb</code></td> + <td><js>"a/b"</js></td> + </tr> + </table> + + <h5 class='section'>Example:</h5> + <p class='bcode'> + <jc>// REST method</jc> + <ja>@RestMethod</ja>(name=<js>"GET"</js>,path=<js>"/foo/{bar}/*"</js>) + <jk>public</jk> String doGetById(RequestPathParams pathParams, <jk>int</jk> bar) { + <jk>return</jk> pathParams.getRemainder(); + } + + <jc>// Prints "path/remainder"</jc> + <jk>new</jk> RestCall(servletPath + <js>"/foo/123/path/remainder"</js>).connect(); + </p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The path remainder string.</dd> +</dl> +</li> +</ul> +<a name="getRemainderUndecoded--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRemainderUndecoded</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/RequestPathMatch.html#line.210">getRemainderUndecoded</a>()</pre> +<div class="block">Same as <a href="../../../../org/apache/juneau/rest/RequestPathMatch.html#getRemainder--"><code>getRemainder()</code></a> but doesn't decode characters.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The undecoded path remainder.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/juneau/rest/RequestHeaders.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/rest/RequestPathMatch.html" target="_top">Frames</a></li> +<li><a href="RequestPathMatch.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.java.util.AbstractMap">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
