You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/01 23:55:44 UTC
[26/32] incubator-juneau-website git commit: Update javadocs
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/19e9b7df/content/site/apidocs/org/apache/juneau/rest/RequestQuery.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/rest/RequestQuery.html b/content/site/apidocs/org/apache/juneau/rest/RequestQuery.html
index 3063752..50f8d4d 100644
--- a/content/site/apidocs/org/apache/juneau/rest/RequestQuery.html
+++ b/content/site/apidocs/org/apache/juneau/rest/RequestQuery.html
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -127,7 +127,7 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<br>
-<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.29">RequestQuery</a>
+<pre>public final class <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.30">RequestQuery</a>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</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">Represents the query parameters in an HTTP request.</div>
<dl>
@@ -265,6 +265,16 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
<div class="block">Sets a request query parameter value.</div>
</td>
</tr>
+<tr id="i11" 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/RequestQuery.html#toString--">toString</a></span>()</code> </td>
+</tr>
+<tr id="i12" 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/RequestQuery.html#toString-boolean-">toString</a></span>(boolean sorted)</code>
+<div class="block">Converts the query parameters to a readable string.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.LinkedHashMap">
@@ -285,7 +295,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
<!-- -->
</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#toString--" title="class or interface in java.util">toString</a></code></li>
+<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></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@@ -321,7 +331,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
<ul class="blockListLast">
<li class="blockList">
<h4>RequestQuery</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.29">RequestQuery</a>()</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.30">RequestQuery</a>()</pre>
</li>
</ul>
</li>
@@ -338,7 +348,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
<ul class="blockList">
<li class="blockList">
<h4>addDefault</h4>
-<pre>public <a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest">RequestQuery</a> <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.53">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>
+<pre>public <a href="../../../../org/apache/juneau/rest/RequestQuery.html" title="class in org.apache.juneau.rest">RequestQuery</a> <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.54">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 query parameters.
<p>
This includes the default queries defined on the servlet and method levels.</div>
@@ -356,7 +366,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
-<pre>public void <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.71">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/RequestQuery.html#line.72">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>
@@ -372,7 +382,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/RequestQuery.html#line.85">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/RequestQuery.html#line.86">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 query parameter value.
<p>
Same as <a href="http://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true#getParameter-java.lang.String-" title="class or interface in javax.servlet"><code>ServletRequest.getParameter(String)</code></a> except only looks in the URL string, not parameters from URL-Encoded FORM posts.
@@ -392,7 +402,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/RequestQuery.html#line.106">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/RequestQuery.html#line.107">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/RequestQuery.html#getFirst-java.lang.String-"><code>getFirst(String)</code></a> but returns the specified default value if the query parameter was not specified.</div>
<dl>
@@ -410,7 +420,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/RequestQuery.html#line.140">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/RequestQuery.html#line.141">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 query parameter value converted to a POJO.
@@ -455,7 +465,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/RequestQuery.html#line.154">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/RequestQuery.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,
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>
@@ -480,7 +490,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/RequestQuery.html#line.190">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/RequestQuery.html#line.191">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>
@@ -527,7 +537,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/RequestQuery.html#line.208">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/RequestQuery.html#line.209">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/Object.html?is-external=true" title="class or interface in java.lang">Object</a> def,
<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)
@@ -557,7 +567,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/RequestQuery.html#line.224">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/RequestQuery.html#line.225">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> c)
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/RequestQuery.html#get-java.lang.String-java.lang.Class-"><code>get(String, Class)</code></a> except for use on multi-part parameters
@@ -583,7 +593,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/RequestQuery.html#line.244">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/RequestQuery.html#line.245">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>
@@ -611,10 +621,10 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
<a name="containsAnyKeys-java.lang.String...-">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>containsAnyKeys</h4>
-<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.254">containsAnyKeys</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>... params)</pre>
+<pre>public boolean <a href="../../../../src-html/org/apache/juneau/rest/RequestQuery.html#line.255">containsAnyKeys</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>... params)</pre>
<div class="block">Returns <jk>true</jk> if the request contains any of the specified query parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -624,6 +634,35 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa
</dl>
</li>
</ul>
+<a name="toString-boolean-">
+<!-- -->
+</a>
+<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/RequestQuery.html#line.315">toString</a>(boolean sorted)</pre>
+<div class="block">Converts the query parameters to a readable string.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>sorted</code> - Sort the query parameters by name.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A JSON string containing the contents of the query parameters.</dd>
+</dl>
+</li>
+</ul>
+<a name="toString--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<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/RequestQuery.html#line.325">toString</a>()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code><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> in class <code><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><<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>[]></code></dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
</li>