| <!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.rest.httppart;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static org.apache.juneau.httppart.HttpPartType.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import java.lang.reflect.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.util.regex.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.http.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.juneau.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.juneau.httppart.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.juneau.rest.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * Represents a single query parameter on an HTTP request.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <p><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Typically accessed through the {@link RequestQueryParams} class.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Some important methods on this class are:<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * </p><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <ul class='javatree'><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <li class='jc'>{@link RequestQueryParam}<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <ul class='spaced-list'><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <li>Methods for retrieving simple string values:<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <ul class='javatreec'><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <li class='jm'>{@link RequestQueryParam#asString() asString()}<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li class='jm'>{@link RequestQueryParam#get() get()}<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li class='jm'>{@link RequestQueryParam#isPresent() isPresent()}<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li class='jm'>{@link RequestQueryParam#orElse(String) orElse(String)}<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <li>Methods for retrieving as other common types:<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <ul class='javatreec'><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <li class='jm'>{@link RequestQueryParam#asBoolean() asBoolean()}<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <li class='jm'>{@link RequestQueryParam#asBooleanPart() asBooleanPart()}<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <li class='jm'>{@link RequestQueryParam#asCsvArray() asCsvArray()}<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <li class='jm'>{@link RequestQueryParam#asCsvArrayPart() asCsvArrayPart()}<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <li class='jm'>{@link RequestQueryParam#asDate() asDate()}<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <li class='jm'>{@link RequestQueryParam#asDatePart() asDatePart()}<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <li class='jm'>{@link RequestQueryParam#asInteger() asInteger()}<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <li class='jm'>{@link RequestQueryParam#asIntegerPart() asIntegerPart()}<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <li class='jm'>{@link RequestQueryParam#asLong() asLong()}<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <li class='jm'>{@link RequestQueryParam#asLongPart() asLongPart()}<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <li class='jm'>{@link RequestQueryParam#asMatcher(Pattern) asMatcher(Pattern)}<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <li class='jm'>{@link RequestQueryParam#asMatcher(String) asMatcher(String)}<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <li class='jm'>{@link RequestQueryParam#asMatcher(String,int) asMatcher(String,int)}<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <li class='jm'>{@link RequestQueryParam#asStringPart() asStringPart()}<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <li class='jm'>{@link RequestQueryParam#asUriPart() asUriPart()}<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * </ul><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <li>Methods for retrieving as custom types:<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <ul class='javatreec'><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <li class='jm'>{@link RequestQueryParam#as(Class) as(Class)}<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <li class='jm'>{@link RequestQueryParam#as(ClassMeta) as(ClassMeta)}<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <li class='jm'>{@link RequestQueryParam#as(Type,Type...) as(Type,Type...)}<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <li class='jm'>{@link RequestQueryParam#parser(HttpPartParserSession) parser(HttpPartParserSession)}<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <li class='jm'>{@link RequestQueryParam#schema(HttpPartSchema) schema(HttpPartSchema)}<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * </ul><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <li>Methods for performing assertion checks:<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <ul class='javatreec'><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <li class='jm'>{@link RequestQueryParam#assertCsvArray() assertCsvArray()}<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <li class='jm'>{@link RequestQueryParam#assertDate() assertDate()}<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * <li class='jm'>{@link RequestQueryParam#assertInteger() assertInteger()}<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <li class='jm'>{@link RequestQueryParam#assertLong() assertLong()}<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <li class='jm'>{@link RequestQueryParam#assertString() assertString()}<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * </ul><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <li>Other methods:<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <ul class='javatreec'><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <li class='jm'>{@link RequestQueryParam#getName() getName()}<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <li class='jm'>{@link RequestQueryParam#getValue() getValue()}<a name="line.81"></a> |
| <span class="sourceLineNo">082</span>* </ul><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * </ul><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> *<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <ul class='seealso'><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <li class='link'>{@doc jrs.HttpParts}<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <li class='extlink'>{@source}<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * </ul><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span>public class RequestQueryParam extends RequestHttpPart implements NameValuePair {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Constructor.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> *<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param request The request object.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param name The parameter name.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @param value The parameter value.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public RequestQueryParam(RestRequest request, String name, String value) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> super(QUERY, request, name, value);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> // <FluentSetters><a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> @Override /* GENERATED */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public RequestQueryParam schema(HttpPartSchema value) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> super.schema(value);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> return this;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> @Override /* GENERATED */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> public RequestQueryParam parser(HttpPartParserSession value) {<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> super.parser(value);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return this;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // </FluentSetters><a name="line.116"></a> |
| <span class="sourceLineNo">117</span>}<a name="line.117"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
