Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.12.1 / src-html / org / apache / felix / ipojo / manipulator / metadata / annotation / ComponentWorkbench.html
blob: e40577d74919ad16fba0da8aacc5626a9f134013 [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;<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.registry.BindingRegistry;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.objectweb.asm.Type;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.objectweb.asm.tree.ClassNode;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.LinkedHashMap;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Map;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.TreeMap;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>public class ComponentWorkbench {<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> * Root element (usually &lt;component /&gt; or &lt;handler/&gt;).<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Maybe null until set.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span> private Element root;<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> * Instance element (may be {@literal null}).<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> private Element instance;<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> * Map of [element ids, element].<a name="line.48"></a>
<span class="sourceLineNo">049</span> * This map is used to easily get an already created element.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> private Map&lt;String, Element&gt; m_ids = new TreeMap&lt;String, Element&gt;();<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Map of [element, referto].<a name="line.54"></a>
<span class="sourceLineNo">055</span> * This map is used to recreate the element hierarchy.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Stored element are added under referred element.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> private Map&lt;Element, String&gt; m_elements = new LinkedHashMap&lt;Element, String&gt;();<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> private Type type;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> private BindingRegistry bindingRegistry;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> private ClassNode classNode;<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 flag indicating if the class needs to be ignored.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> private boolean toIgnore;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> public ComponentWorkbench(BindingRegistry bindingRegistry, ClassNode node) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> this.bindingRegistry = bindingRegistry;<a name="line.72"></a>
<span class="sourceLineNo">073</span> this.classNode = node;<a name="line.73"></a>
<span class="sourceLineNo">074</span> this.type = Type.getObjectType(node.name);<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> public Type getType() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return type;<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> public BindingRegistry getBindingRegistry() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return bindingRegistry;<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> public ClassNode getClassNode() {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return classNode;<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
<span class="sourceLineNo">090</span> * The identified root Element. May be null if at the visit time, the root as not been identified.<a name="line.90"></a>
<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @return the root Element. or {@literal null} if not defined at the execution time.<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> public Element getRoot() {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return root;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> public void setRoot(Element root) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> // TODO check if root already assigned<a name="line.99"></a>
<span class="sourceLineNo">100</span> this.root = root;<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> public Element getInstance() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return instance;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> public void setInstance(Element instance) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.instance = instance;<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> public Map&lt;String, Element&gt; getIds() {<a name="line.111"></a>
<span class="sourceLineNo">112</span> return m_ids;<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> public Map&lt;Element, String&gt; getElements() {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return m_elements;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> public Element build() {<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> if (root == null) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> // No 'top level' component Element has been registered<a name="line.122"></a>
<span class="sourceLineNo">123</span> return null;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> // Iterates on all contributed Elements<a name="line.126"></a>
<span class="sourceLineNo">127</span> for (Element current : m_elements.keySet()) {<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> // If the traversed Element has a reference to another Element,<a name="line.129"></a>
<span class="sourceLineNo">130</span> // it has to be moved inside that referenced Element<a name="line.130"></a>
<span class="sourceLineNo">131</span> // This is useful for contributing data to other handlers<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> String refId = m_elements.get(current);<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (refId == null) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> // No reference provided, just add it a a direct child<a name="line.135"></a>
<span class="sourceLineNo">136</span> root.addElement(current);<a name="line.136"></a>
<span class="sourceLineNo">137</span> } else {<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> // Get the referenced Element (if any)<a name="line.139"></a>
<span class="sourceLineNo">140</span> Element ref = m_ids.get(refId);<a name="line.140"></a>
<span class="sourceLineNo">141</span> if (ref == null) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> // Add to the root Element<a name="line.142"></a>
<span class="sourceLineNo">143</span> root.addElement(current);<a name="line.143"></a>
<span class="sourceLineNo">144</span> } else {<a name="line.144"></a>
<span class="sourceLineNo">145</span> // Add as child of the referenced Element<a name="line.145"></a>
<span class="sourceLineNo">146</span> ref.addElement(current);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> // Clear<a name="line.151"></a>
<span class="sourceLineNo">152</span> m_ids.clear();<a name="line.152"></a>
<span class="sourceLineNo">153</span> m_elements.clear();<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> return root;<a name="line.155"></a>
<span class="sourceLineNo">156</span><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> /**<a name="line.159"></a>
<span class="sourceLineNo">160</span> * Checks whether this class must be ignored.<a name="line.160"></a>
<span class="sourceLineNo">161</span> *<a name="line.161"></a>
<span class="sourceLineNo">162</span> * @return {@code true} if the class is ignored.<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> public boolean ignore() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return toIgnore;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
<span class="sourceLineNo">169</span> * Sets the 'ignore' aspect of the current class.<a name="line.169"></a>
<span class="sourceLineNo">170</span> *<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param ignore whether or not the class must be ignored.<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> public void ignore(boolean ignore) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> this.toIgnore = ignore;<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span>}<a name="line.176"></a>
</pre>
</div>
</body>
</html>