blob: 7c6e06099b74730e782ba15a6b951199a1093431 [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.rest.helper;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.apache.juneau.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.apache.juneau.annotation.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>/**<a name="line.18"></a>
<span class="sourceLineNo">019</span> * Simple serializable bean description.<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;p&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Given a particular class type, this serializes the class into the fully-qualified class name and the properties<a name="line.22"></a>
<span class="sourceLineNo">023</span> * associated with the class.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Useful for rendering simple information about a bean during REST OPTIONS requests.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;ul class='seealso'&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;li class='link'&gt;{@doc juneau-rest-server.RestMethod.PredefinedHelperBeans}<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;/ul&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>@Bean(bpi="type,properties")<a name="line.32"></a>
<span class="sourceLineNo">033</span>public final class BeanDescription {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> /** The bean class type. */<a name="line.35"></a>
<span class="sourceLineNo">036</span> public String type;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> /** The bean properties. */<a name="line.38"></a>
<span class="sourceLineNo">039</span> public BeanPropertyDescription[] properties;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Constructor<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @param c The bean class type.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> public BeanDescription(Class&lt;?&gt; c) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> type = c.getName();<a name="line.47"></a>
<span class="sourceLineNo">048</span> BeanMeta&lt;?&gt; bm = BeanContext.DEFAULT.getBeanMeta(c);<a name="line.48"></a>
<span class="sourceLineNo">049</span> if (bm == null)<a name="line.49"></a>
<span class="sourceLineNo">050</span> throw new FormattedRuntimeException("Class ''{0}'' is not a valid bean.", c);<a name="line.50"></a>
<span class="sourceLineNo">051</span> properties = new BeanPropertyDescription[bm.getPropertyMetas().size()];<a name="line.51"></a>
<span class="sourceLineNo">052</span> int i = 0;<a name="line.52"></a>
<span class="sourceLineNo">053</span> for (BeanPropertyMeta pm : bm.getPropertyMetas())<a name="line.53"></a>
<span class="sourceLineNo">054</span> properties[i++] = new BeanPropertyDescription(pm.getName(), pm.getClassMeta());<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<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> * Information about a bean property.<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> public static class BeanPropertyDescription {<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /** The bean property name. */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public String name;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /** The bean property filtered class type. */<a name="line.65"></a>
<span class="sourceLineNo">066</span> public String type;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> /**<a name="line.68"></a>
<span class="sourceLineNo">069</span> * Constructor.<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param name The bean property name.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param type The bean property class type.<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public BeanPropertyDescription(String name, ClassMeta&lt;?&gt; type) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> this.name = name;<a name="line.75"></a>
<span class="sourceLineNo">076</span> this.type = type.getSerializedClassMeta(null).toString();<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span>}<a name="line.79"></a>
</pre>
</div>
</body>
</html>