Google Git
Sign in
apache / juneau-website / 3ec6a38af8eff23af4011afbc4a002edec02bd97 / . / content / site / apidocs-9.0.0 / src-html / org / apache / juneau / http / annotation / HasQuery.html
blob: 68f0615c26ea282d9cd07170582a3c2d44daaa9d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a>
<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.http.annotation;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * REST has-query-parameter annotation.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Identifies whether or not an HTTP request has the specified query parameter.<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Can be used in the following locations:<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;ul&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;li&gt;Arguments and argument-types of server-side &lt;ja&gt;@RestOp&lt;/ja&gt;-annotated methods.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;/ul&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Identical to {@link HasFormData @HasFormData}, but only checks the existing of the parameter in the URL string, not<a name="line.32"></a>
<span class="sourceLineNo">033</span> * URL-encoded form posts.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Unlike {@link HasFormData @HasFormData}, using this annotation does not result in the servlet reading the contents<a name="line.36"></a>
<span class="sourceLineNo">037</span> * of URL-encoded form posts.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Therefore, this annotation can be used in conjunction with the {@link Content @Cpmtemt} annotation or<a name="line.38"></a>
<span class="sourceLineNo">039</span> * {@code RestRequest.getContent()} method for &lt;c&gt;application/x-www-form-urlencoded POST&lt;/c&gt; calls.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;/p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;h5 class='figure'&gt;Example:&lt;/h5&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p class='bjava'&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;ja&gt;@RestGet&lt;/ja&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;jk&gt;public void&lt;/jk&gt; doGet(&lt;ja&gt;@HasQuery&lt;/ja&gt;(&lt;js&gt;"p1"&lt;/js&gt;) &lt;jk&gt;boolean&lt;/jk&gt; &lt;jv&gt;p1&lt;/jv&gt;) {...}<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;p&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * This is functionally equivalent to the following code:<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;/p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;p class='bjava'&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;ja&gt;@RestGet&lt;/ja&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;jk&gt;public void&lt;/jk&gt; doGet(RestRequest &lt;jv&gt;req&lt;/jv&gt;) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;jk&gt;boolean&lt;/jk&gt; &lt;jv&gt;p1&lt;/jv&gt; = &lt;jv&gt;req&lt;/jv&gt;.getQueryParam(&lt;js&gt;"p1"&lt;/js&gt;).isPresent();<a name="line.52"></a>
<span class="sourceLineNo">053</span> * ...<a name="line.53"></a>
<span class="sourceLineNo">054</span> * }<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;/p&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;p&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> * The parameter type must be either &lt;jk&gt;boolean&lt;/jk&gt; or {@link java.lang.Boolean}.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;/p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * The following table shows the behavioral differences between &lt;ja&gt;@HasQuery&lt;/ja&gt; and &lt;ja&gt;@Query&lt;/ja&gt;:<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;/p&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;table class='styled w400'&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;tr&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &lt;th&gt;&lt;c&gt;Query content&lt;/c&gt;&lt;/th&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;th&gt;&lt;c&gt;&lt;ja&gt;@HasQuery&lt;/ja&gt;(&lt;js&gt;"a"&lt;/js&gt;)&lt;/c&gt;&lt;/th&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;th&gt;&lt;c&gt;&lt;ja&gt;@Query&lt;/ja&gt;(&lt;js&gt;"a"&lt;/js&gt;)&lt;/c&gt;&lt;/th&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;/tr&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;tr&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;td&gt;&lt;c&gt;?a=foo&lt;/c&gt;&lt;/td&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;td&gt;&lt;jk&gt;true&lt;/jk&gt;&lt;/td&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;td&gt;&lt;js&gt;"foo"&lt;/js&gt;&lt;/td&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;/tr&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;tr&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;td&gt;&lt;c&gt;?a=&lt;/c&gt;&lt;/td&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;td&gt;&lt;jk&gt;true&lt;/jk&gt;&lt;/td&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;td&gt;&lt;js&gt;""&lt;/js&gt;&lt;/td&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;/tr&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> * &lt;tr&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;td&gt;&lt;c&gt;?a&lt;/c&gt;&lt;/td&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;td&gt;&lt;jk&gt;true&lt;/jk&gt;&lt;/td&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;td&gt;&lt;jk&gt;null&lt;/jk&gt;&lt;/td&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * &lt;/tr&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;tr&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;td&gt;&lt;c&gt;?b=foo&lt;/c&gt;&lt;/td&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;td&gt;&lt;jk&gt;false&lt;/jk&gt;&lt;/td&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;td&gt;&lt;jk&gt;null&lt;/jk&gt;&lt;/td&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;/tr&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;/table&gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;p&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;ul class='seealso'&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;li class='extlink'&gt;{@source}<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;/ul&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span>@Documented<a name="line.94"></a>
<span class="sourceLineNo">095</span>@Target({PARAMETER})<a name="line.95"></a>
<span class="sourceLineNo">096</span>@Retention(RUNTIME)<a name="line.96"></a>
<span class="sourceLineNo">097</span>@Inherited<a name="line.97"></a>
<span class="sourceLineNo">098</span>public @interface HasQuery {<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * URL query parameter name.<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Required. The name of the parameter. Parameter names are case sensitive.<a name="line.103"></a>
<span class="sourceLineNo">104</span> *<a name="line.104"></a>
<span class="sourceLineNo">105</span> * &lt;ul class='notes'&gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;li class='note'&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * The format is plain-text.<a name="line.107"></a>
<span class="sourceLineNo">108</span> * &lt;/ul&gt;<a name="line.108"></a>
<span class="sourceLineNo">109</span> *<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @return The annotation value.<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> String name() default "";<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> /**<a name="line.114"></a>
<span class="sourceLineNo">115</span> * A synonym for {@link #name()}.<a name="line.115"></a>
<span class="sourceLineNo">116</span> *<a name="line.116"></a>
<span class="sourceLineNo">117</span> * &lt;p&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * Allows you to use shortened notation if you're only specifying the name.<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * &lt;p&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span> * The following are completely equivalent ways of defining the existence of a query entry:<a name="line.121"></a>
<span class="sourceLineNo">122</span> * &lt;p class='bjava'&gt;<a name="line.122"></a>
<span class="sourceLineNo">123</span> * &lt;jk&gt;public&lt;/jk&gt; Order placeOrder(&lt;ja&gt;@HasQuery&lt;/ja&gt;(name=&lt;js&gt;"petId"&lt;/js&gt;) &lt;jk&gt;boolean&lt;/jk&gt; &lt;jv&gt;hasPetId&lt;/jv&gt;) {...}<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;/p&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> * &lt;p class='bjava'&gt;<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;jk&gt;public&lt;/jk&gt; Order placeOrder(&lt;ja&gt;@HasQuery&lt;/ja&gt;(&lt;js&gt;"petId"&lt;/js&gt;) &lt;jk&gt;boolean&lt;/jk&gt; &lt;jv&gt;hasPetId&lt;/jv&gt;) {...}<a name="line.126"></a>
<span class="sourceLineNo">127</span> * &lt;/p&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span> *<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @return The annotation value.<a name="line.129"></a>
<span class="sourceLineNo">130</span> */<a name="line.130"></a>
<span class="sourceLineNo">131</span> String value() default "";<a name="line.131"></a>
<span class="sourceLineNo">132</span>}<a name="line.132"></a>
</pre>
</div>
</body>
</html>