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/05/08 15:32:35 UTC
[05/51] [partial] incubator-juneau-website git commit: Support for
passing in more class types to REST methods.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/rest/RestParam.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestParam.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestParam.html
new file mode 100644
index 0000000..fccff81
--- /dev/null
+++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestParam.html
@@ -0,0 +1,162 @@
+<!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;<a name="line.13"></a>
+<span class="sourceLineNo">014</span><a name="line.14"></a>
+<span class="sourceLineNo">015</span>import java.lang.reflect.*;<a name="line.15"></a>
+<span class="sourceLineNo">016</span><a name="line.16"></a>
+<span class="sourceLineNo">017</span>import org.apache.juneau.rest.annotation.*;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * REST java method parameter resolver.<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * <p><a name="line.21"></a>
+<span class="sourceLineNo">022</span> * Used to resolve instances of classes being passed to Java REST methods.<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * <p><a name="line.23"></a>
+<span class="sourceLineNo">024</span> * This class is associated with REST classes via the {@link RestResource#paramResolvers()} annotation and<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * {@link RestConfig#addParamResolvers(Class...)} method.<a name="line.25"></a>
+<span class="sourceLineNo">026</span> */<a name="line.26"></a>
+<span class="sourceLineNo">027</span>public abstract class RestParam {<a name="line.27"></a>
+<span class="sourceLineNo">028</span><a name="line.28"></a>
+<span class="sourceLineNo">029</span> final RestParamType paramType;<a name="line.29"></a>
+<span class="sourceLineNo">030</span> final String name;<a name="line.30"></a>
+<span class="sourceLineNo">031</span> final Type type;<a name="line.31"></a>
+<span class="sourceLineNo">032</span><a name="line.32"></a>
+<span class="sourceLineNo">033</span> /**<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * Constructor.<a name="line.34"></a>
+<span class="sourceLineNo">035</span> *<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * @param paramType The Swagger parameter type.<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * @param name The parameter name.<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * Can be <jk>null</jk> if parameter doesn't have a name (e.g. the request body).<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * @param type The object type to convert the parameter to.<a name="line.39"></a>
+<span class="sourceLineNo">040</span> */<a name="line.40"></a>
+<span class="sourceLineNo">041</span> protected RestParam(RestParamType paramType, String name, Type type) {<a name="line.41"></a>
+<span class="sourceLineNo">042</span> this.paramType = paramType;<a name="line.42"></a>
+<span class="sourceLineNo">043</span> this.name = name;<a name="line.43"></a>
+<span class="sourceLineNo">044</span> this.type = type;<a name="line.44"></a>
+<span class="sourceLineNo">045</span> }<a name="line.45"></a>
+<span class="sourceLineNo">046</span><a name="line.46"></a>
+<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * Resolves the parameter object.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> *<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * @param req The rest request.<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * @param res The rest response.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * @return The resolved object.<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * @throws Exception<a name="line.53"></a>
+<span class="sourceLineNo">054</span> */<a name="line.54"></a>
+<span class="sourceLineNo">055</span> public abstract Object resolve(RestRequest req, RestResponse res) throws Exception;<a name="line.55"></a>
+<span class="sourceLineNo">056</span><a name="line.56"></a>
+<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * Returns the parameter class type that this parameter resolver is meant for.<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * @return The parameter class type, or <jk>null</jk> if the type passed in isn't an instance of {@link Class}.<a name="line.59"></a>
+<span class="sourceLineNo">060</span> */<a name="line.60"></a>
+<span class="sourceLineNo">061</span> protected Class<?> forClass() {<a name="line.61"></a>
+<span class="sourceLineNo">062</span> if (type instanceof Class)<a name="line.62"></a>
+<span class="sourceLineNo">063</span> return (Class<?>)type;<a name="line.63"></a>
+<span class="sourceLineNo">064</span> return null;<a name="line.64"></a>
+<span class="sourceLineNo">065</span> }<a name="line.65"></a>
+<span class="sourceLineNo">066</span><a name="line.66"></a>
+<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * Returns the swagger parameter type for this parameter as shown in the Swagger doc.<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * @return the swagger parameter type for this parameter.<a name="line.69"></a>
+<span class="sourceLineNo">070</span> */<a name="line.70"></a>
+<span class="sourceLineNo">071</span> protected RestParamType getParamType() {<a name="line.71"></a>
+<span class="sourceLineNo">072</span> return paramType;<a name="line.72"></a>
+<span class="sourceLineNo">073</span> }<a name="line.73"></a>
+<span class="sourceLineNo">074</span><a name="line.74"></a>
+<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * Returns the parameter name for this parameter as shown in the Swagger doc.<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * @return the parameter name for this parameter.<a name="line.77"></a>
+<span class="sourceLineNo">078</span> */<a name="line.78"></a>
+<span class="sourceLineNo">079</span> protected String getName() {<a name="line.79"></a>
+<span class="sourceLineNo">080</span> return name;<a name="line.80"></a>
+<span class="sourceLineNo">081</span> }<a name="line.81"></a>
+<span class="sourceLineNo">082</span><a name="line.82"></a>
+<span class="sourceLineNo">083</span> /**<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * Returns the parameter class type.<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * @return the parameter class type.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> */<a name="line.86"></a>
+<span class="sourceLineNo">087</span> public Type getType() {<a name="line.87"></a>
+<span class="sourceLineNo">088</span> return type;<a name="line.88"></a>
+<span class="sourceLineNo">089</span> }<a name="line.89"></a>
+<span class="sourceLineNo">090</span>}<a name="line.90"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/rest/RestParamType.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestParamType.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestParamType.html
new file mode 100644
index 0000000..b7c26c1
--- /dev/null
+++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestParamType.html
@@ -0,0 +1,120 @@
+<!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;<a name="line.13"></a>
+<span class="sourceLineNo">014</span><a name="line.14"></a>
+<span class="sourceLineNo">015</span>/**<a name="line.15"></a>
+<span class="sourceLineNo">016</span> * Represents the possible parameter types as defined by the Swagger 2.0 specification.<a name="line.16"></a>
+<span class="sourceLineNo">017</span> */<a name="line.17"></a>
+<span class="sourceLineNo">018</span>public enum RestParamType {<a name="line.18"></a>
+<span class="sourceLineNo">019</span><a name="line.19"></a>
+<span class="sourceLineNo">020</span> /** Path variable */<a name="line.20"></a>
+<span class="sourceLineNo">021</span> PATH("path"),<a name="line.21"></a>
+<span class="sourceLineNo">022</span><a name="line.22"></a>
+<span class="sourceLineNo">023</span> /** Header value */<a name="line.23"></a>
+<span class="sourceLineNo">024</span> HEADER("header"),<a name="line.24"></a>
+<span class="sourceLineNo">025</span><a name="line.25"></a>
+<span class="sourceLineNo">026</span> /** Form data entry */<a name="line.26"></a>
+<span class="sourceLineNo">027</span> FORMDATA("formData"),<a name="line.27"></a>
+<span class="sourceLineNo">028</span><a name="line.28"></a>
+<span class="sourceLineNo">029</span> /** Query parameter */<a name="line.29"></a>
+<span class="sourceLineNo">030</span> QUERY("query"),<a name="line.30"></a>
+<span class="sourceLineNo">031</span><a name="line.31"></a>
+<span class="sourceLineNo">032</span> /** Request body */<a name="line.32"></a>
+<span class="sourceLineNo">033</span> BODY("body"),<a name="line.33"></a>
+<span class="sourceLineNo">034</span><a name="line.34"></a>
+<span class="sourceLineNo">035</span> /** Not a standard Swagger-defined field */<a name="line.35"></a>
+<span class="sourceLineNo">036</span> OTHER("other");<a name="line.36"></a>
+<span class="sourceLineNo">037</span><a name="line.37"></a>
+<span class="sourceLineNo">038</span> private final String value;<a name="line.38"></a>
+<span class="sourceLineNo">039</span><a name="line.39"></a>
+<span class="sourceLineNo">040</span> private RestParamType(String value) {<a name="line.40"></a>
+<span class="sourceLineNo">041</span> this.value = value;<a name="line.41"></a>
+<span class="sourceLineNo">042</span> }<a name="line.42"></a>
+<span class="sourceLineNo">043</span><a name="line.43"></a>
+<span class="sourceLineNo">044</span> @Override /* Object */<a name="line.44"></a>
+<span class="sourceLineNo">045</span> public String toString() {<a name="line.45"></a>
+<span class="sourceLineNo">046</span> return value;<a name="line.46"></a>
+<span class="sourceLineNo">047</span> }<a name="line.47"></a>
+<span class="sourceLineNo">048</span>}<a name="line.48"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>