| <!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.spi;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import static org.apache.felix.ipojo.manipulator.spi.helper.Predicates.onlySupportedElements;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.lang.annotation.Annotation;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Iterator;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.model.AnnotationType;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.model.literal.AnnotationLiteral;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.model.literal.AnnotationPlayback;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.registry.Binding;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.visitor.generic.GenericVisitorFactory;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.visitor.ignore.NullBinding;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.visitor.stereotype.StereotypeVisitorFactory;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.visitor.util.Elements;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.objectweb.asm.Type;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>/**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * All provided {@link Module}s have to inherit from this class.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * It provides a simple to use DSL to express annotation bindings.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public abstract class AbsBindingModule implements Module {<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> * Build bindings.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private List<Binding> bindings = new ArrayList<Binding>();<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public Iterator<Binding> iterator() {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> return bindings.iterator();<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> }<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> * Initiate an annotation binding.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Examples:<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <pre><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * AnnotationVisitorFactory factory = new CompositeVisitorFactory();<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * bind(Composite.class).to(factory);<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * bind(Composite.class).when(.. some condition ..)<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * .to(factory);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * </pre><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param annotationType the annotation that will be bound to the {@link AnnotationVisitorFactory}<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> protected AnnotationBindingBuilder bind(Class<? extends Annotation> annotationType) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> return new AnnotationBindingBuilder(bindings, annotationType);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> }<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> protected StereotypeBindingBuilder bindStereotype(Class<? extends Annotation> annotationType) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return new StereotypeBindingBuilder(bindings, annotationType);<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> protected HandlerBindingBuilder bindHandlerBinding(Class<? extends Annotation> annotationType) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return new HandlerBindingBuilder(bindings, annotationType);<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> protected void bindIgnore(Class<? extends Annotation> annotationType) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> bindings.add(new NullBinding(Type.getType(annotationType)));<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> * DSL helper class.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public class AnnotationBindingBuilder {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> private Class<? extends Annotation> annotationType;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private AnnotationVisitorFactory factory;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> private List<Binding> registry;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public AnnotationBindingBuilder(List<Binding> registry,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> Class<? extends Annotation> annotationType) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.registry = registry;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.annotationType = annotationType;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<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> * Declares a {@link Predicate} that will add a condition to the annotation binding.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @see org.apache.felix.ipojo.manipulator.spi.helper.Predicates<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param predicate the predicate to use<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> public ConditionalBindingBuilder when(Predicate predicate) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return new ConditionalBindingBuilder(this, predicate);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<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> * Complete the annotation binding with the {@link AnnotationVisitorFactory} to be executed<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * when the annotation is found.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param factory to be executed when the annotation is found.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public void to(AnnotationVisitorFactory factory) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> this.factory = factory;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> registry.add(build());<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> /**<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * Creates the Binding.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> private Binding build() {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> Binding binding = new Binding();<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> binding.setAnnotationType(Type.getType(annotationType));<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> binding.setPredicate(onlySupportedElements(annotationType));<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> binding.setFactory(factory);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return binding;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public class ConditionalBindingBuilder {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> private AnnotationBindingBuilder parent;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> private Predicate predicate;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> private AnnotationVisitorFactory factory;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> public ConditionalBindingBuilder(AnnotationBindingBuilder parent, Predicate predicate) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> this.parent = parent;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> this.predicate = predicate;<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<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> * Complete the annotation binding with the {@link AnnotationVisitorFactory} to be executed<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * when the annotation is found.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @param factory to be executed when the annotation is found.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public AnnotationBindingBuilder to(AnnotationVisitorFactory factory) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> this.factory = factory;<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> bindings.add(build());<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> return parent;<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> /**<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * Creates the Binding.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> private Binding build() {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> Binding binding = parent.build();<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> binding.setPredicate(predicate);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> binding.setFactory(factory);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return binding;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> public class StereotypeBindingBuilder {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> private final AnnotationType m_annotationType;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public StereotypeBindingBuilder(final List<Binding> bindings, final Class<? extends Annotation> type) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> m_annotationType = new AnnotationType(Type.getType(type));<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> Binding binding = new Binding();<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> binding.setAnnotationType(m_annotationType.getType());<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> binding.setPredicate(onlySupportedElements(type));<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> binding.setFactory(new StereotypeVisitorFactory(m_annotationType));<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> bindings.add(binding);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> public StereotypeBindingBuilder with(AnnotationLiteral<?> literal) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> m_annotationType.getPlaybacks().add(new AnnotationPlayback(literal));<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return this;<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public class HandlerBindingBuilder {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> private final Binding m_binding;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public HandlerBindingBuilder(final List<Binding> bindings, final Class<? extends Annotation> annotationType) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> m_binding = new Binding();<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> Type type = Type.getType(annotationType);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> m_binding.setAnnotationType(type);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> m_binding.setPredicate(onlySupportedElements(annotationType));<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> Element e = Elements.buildElement(type);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> m_binding.setFactory(new GenericVisitorFactory(e.getName(), e.getNameSpace()));<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> bindings.add(m_binding);<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> public void to(String namespace, String name) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> m_binding.setFactory(new GenericVisitorFactory(name, namespace));<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span>}<a name="line.198"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |