| <!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.RetentionPolicy.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import java.lang.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> * Swagger contact annotation.<a name="line.20"></a> |
| <span class="sourceLineNo">021</span> *<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * <p><a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * The contact information for the exposed API.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> *<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * <p><a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * Used to populate the auto-generated Swagger documentation and UI for server-side <ja>@Rest</ja>-annotated classes.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <h5 class='section'>Example:</h5><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <p class='bjava'><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <ja>@Swagger</ja>(<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * contact=<ja>@Contact</ja>(<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * name=<js>"Juneau Development Team"</js>,<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * email=<js>"dev@juneau.apache.org"</js>,<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * url=<js>"http://juneau.apache.org"</js><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * )<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * )<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * </p><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <ul class='seealso'><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li class='link'>{@doc jrs.Swagger}<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li class='extlink'>{@doc ext.SwaggerContactObject}<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li class='extlink'>{@source}<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>@Documented<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>@Retention(RUNTIME)<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public @interface Contact {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <mk>email</mk> field of the {@doc ext.SwaggerContactObject}.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> *<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * The email address of the contact person/organization. MUST be in the format of an email address.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <ul class='notes'><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <li class='note'><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * The format is an email string.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <li class='note'><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Supports {@doc jrs.SvlVariables} (e.g. <js>"$L{my.localized.variable}"</js>) for the swagger generator.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * </ul><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> *<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @return The annotation value.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> String email() default "";<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> * <mk>name</mk> field of the {@doc ext.SwaggerContactObject}.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * The identifying name of the contact person/organization.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> *<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <ul class='notes'><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <li class='note'><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * The format is a plain-text string.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <li class='note'><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Supports {@doc jrs.SvlVariables} (e.g. <js>"$L{my.localized.variable}"</js>) for the swagger generator.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * </ul><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return The annotation value.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> String name() default "";<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> * <mk>url</mk> field of the {@doc ext.SwaggerContactObject}.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <p><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * The URL pointing to the contact information. MUST be in the format of a URL.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <ul class='notes'><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <li class='note'><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * The format is a URL string.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * <li class='note'><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Supports {@doc jrs.SvlVariables}<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * </ul><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> *<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @return The annotation value.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> String url() default "";<a name="line.99"></a> |
| <span class="sourceLineNo">100</span>}<a name="line.100"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
