blob: 0b3d21aac2a5433bca50fb7204d25602126c4927 [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="../../../../../../../../../../stylesheet.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<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<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>package org.apache.felix.ipojo.manipulator.metadata.annotation.visitor.bind;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.ComponentWorkbench;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.visitor.RequiresVisitor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.objectweb.asm.AnnotationVisitor;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.objectweb.asm.Type;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.objectweb.asm.commons.EmptyVisitor;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public abstract class AbstractBindVisitor extends EmptyVisitor implements AnnotationVisitor {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> protected ComponentWorkbench workbench;<a name="line.35"></a>
<span class="sourceLineNo">036</span> protected Action action;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> public AbstractBindVisitor(ComponentWorkbench workbench, Action action) {<a name="line.38"></a>
<span class="sourceLineNo">039</span> this.workbench = workbench;<a name="line.39"></a>
<span class="sourceLineNo">040</span> this.action = action;<a name="line.40"></a>
<span class="sourceLineNo">041</span> }<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> * Requirement filter.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> protected String m_filter;<a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Is the requirement optional?<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> protected String m_optional;<a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Is the requirement aggregate?<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> protected String m_aggregate;<a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Required specification.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> protected String m_specification;<a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Requirement id.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> protected String m_id;<a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Binding policy.<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span> protected String m_policy;<a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Comparator.<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> protected String m_comparator;<a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * From attribute.<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> protected String m_from;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * proxy attribute.<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> protected String m_proxy;<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * Visit annotation's attributes.<a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param name : annotation name<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @param value : annotation value<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @see org.objectweb.asm.commons.EmptyVisitor#visit(String, Object)<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public void visit(String name, Object value) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (name.equals("filter")) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> m_filter = value.toString();<a name="line.90"></a>
<span class="sourceLineNo">091</span> return;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (name.equals("optional")) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> m_optional = value.toString();<a name="line.94"></a>
<span class="sourceLineNo">095</span> return;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (name.equals("aggregate")) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> m_aggregate = value.toString();<a name="line.98"></a>
<span class="sourceLineNo">099</span> return;<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (name.equals("specification")) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> // Detect whether it's an internal class name.<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (value.toString().startsWith("L") &amp;&amp; value.toString().endsWith(";")) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> Type type = Type.getType(value.toString());<a name="line.104"></a>
<span class="sourceLineNo">105</span> m_specification = type.getClassName();<a name="line.105"></a>
<span class="sourceLineNo">106</span> } else {<a name="line.106"></a>
<span class="sourceLineNo">107</span> m_specification = value.toString();<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span> return;<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> // Still used by component using the old version of the annotations.<a name="line.111"></a>
<span class="sourceLineNo">112</span> if (name.equals("policy")) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> m_policy = RequiresVisitor.getPolicy(value.toString());<a name="line.113"></a>
<span class="sourceLineNo">114</span> return;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> if (name.equals("id")) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> m_id = value.toString();<a name="line.117"></a>
<span class="sourceLineNo">118</span> return;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> if (name.equals("comparator")) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> Type type = Type.getType(value.toString());<a name="line.121"></a>
<span class="sourceLineNo">122</span> m_comparator = type.getClassName();<a name="line.122"></a>
<span class="sourceLineNo">123</span> return;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> if (name.equals("from")) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> m_from = value.toString();<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span> if (name.equals("proxy")) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> m_proxy = value.toString();<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span> public void visitEnum(String name, String desc, String value) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> if (name.equals("policy")) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> m_policy = RequiresVisitor.getPolicy(value.toString());<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> public void visitEnd() {<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> protected Element getRequiresElement() {<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> // Check if it is a full-determined requirement<a name="line.146"></a>
<span class="sourceLineNo">147</span> Element requires = workbench.getIds().get(m_id);<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (requires == null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> // Add the complete requires<a name="line.149"></a>
<span class="sourceLineNo">150</span> requires = createRequiresElement();<a name="line.150"></a>
<span class="sourceLineNo">151</span> } else {<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (!completeExistingRequires(requires))<a name="line.152"></a>
<span class="sourceLineNo">153</span> return null;<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> return requires;<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> protected boolean completeExistingRequires(Element requires) {<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> if (!completeAttribute(requires, "specification", m_specification))<a name="line.161"></a>
<span class="sourceLineNo">162</span> return false;<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> if (!completeAttribute(requires, "optional", m_optional))<a name="line.164"></a>
<span class="sourceLineNo">165</span> return false;<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> if (!completeAttribute(requires, "aggregate", m_aggregate))<a name="line.167"></a>
<span class="sourceLineNo">168</span> return false;<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> if (!completeAttribute(requires, "filter", m_filter))<a name="line.170"></a>
<span class="sourceLineNo">171</span> return false;<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> if (!completeAttribute(requires, "policy", m_policy))<a name="line.173"></a>
<span class="sourceLineNo">174</span> return false;<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> if (!completeAttribute(requires, "comparator", m_comparator))<a name="line.176"></a>
<span class="sourceLineNo">177</span> return false;<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> if (!completeAttribute(requires, "from", m_from))<a name="line.179"></a>
<span class="sourceLineNo">180</span> return false;<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> if(!completeAttribute(requires, "proxy", m_proxy))<a name="line.182"></a>
<span class="sourceLineNo">183</span> return false;<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> return true;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> private boolean completeAttribute(Element requires, String name, String value) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> // If we have a value<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (value != null) {<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> String old = requires.getAttribute(name);<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (old == null) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> // If the old value was not set, just set the new value<a name="line.194"></a>
<span class="sourceLineNo">195</span> requires.addAttribute(new Attribute(name, value));<a name="line.195"></a>
<span class="sourceLineNo">196</span> } else if (!value.equals(old)) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> //<a name="line.197"></a>
<span class="sourceLineNo">198</span> System.err.println("The '" + name + "' attribute has changed: " + old + " -&gt; " + value);<a name="line.198"></a>
<span class="sourceLineNo">199</span> return false;<a name="line.199"></a>
<span class="sourceLineNo">200</span> } // Otherwise, the old and new value are equals<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> return true;<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> protected Element createRequiresElement() {<a name="line.205"></a>
<span class="sourceLineNo">206</span> Element requires;<a name="line.206"></a>
<span class="sourceLineNo">207</span> requires = new Element("requires", "");<a name="line.207"></a>
<span class="sourceLineNo">208</span> if (m_specification != null) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> requires.addAttribute(new Attribute("specification", m_specification));<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span> if (m_aggregate != null) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> requires.addAttribute(new Attribute("aggregate", m_aggregate));<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> if (m_filter != null) {<a name="line.214"></a>
<span class="sourceLineNo">215</span> requires.addAttribute(new Attribute("filter", m_filter));<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> if (m_optional != null) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> requires.addAttribute(new Attribute("optional", m_optional));<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span> if (m_policy != null) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> requires.addAttribute(new Attribute("policy", m_policy));<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> if (m_id != null) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> requires.addAttribute(new Attribute("id", m_id));<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> if (m_comparator != null) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> requires.addAttribute(new Attribute("comparator", m_comparator));<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span> if (m_from != null) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> requires.addAttribute(new Attribute("from", m_from));<a name="line.230"></a>
<span class="sourceLineNo">231</span> }<a name="line.231"></a>
<span class="sourceLineNo">232</span> if (m_proxy != null) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> requires.addAttribute(new Attribute("proxy", m_proxy));<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span> return requires;<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span>}<a name="line.239"></a>
</pre>
</div>
</body>
</html>