Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.12.1 / src-html / org / apache / felix / ipojo / util / Methods.html
blob: 977a56ead23d6ff6d878608922b7ab955088ccf1 [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.util;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.reflect.Method;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.lang.reflect.Modifier;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.*;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Fluent API to retrieve methods.<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>public class Methods&lt;T&gt; {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span> private Class&lt;? extends T&gt; returnType;<a name="line.31"></a>
<span class="sourceLineNo">032</span> private List&lt;Class&lt;?&gt;&gt; argumentTypes = new ArrayList&lt;Class&lt;?&gt;&gt;();<a name="line.32"></a>
<span class="sourceLineNo">033</span> private Class&lt;?&gt; clazz;<a name="line.33"></a>
<span class="sourceLineNo">034</span> private Object object;<a name="line.34"></a>
<span class="sourceLineNo">035</span> private List&lt;Method&gt; methods;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> public Map&lt;Method, InvocationResult&lt;T&gt;&gt; map(Object... args) {<a name="line.37"></a>
<span class="sourceLineNo">038</span> Collection&lt;Method&gt; set = retrieve();<a name="line.38"></a>
<span class="sourceLineNo">039</span> Map&lt;Method, InvocationResult&lt;T&gt;&gt; results = new LinkedHashMap&lt;Method, InvocationResult&lt;T&gt;&gt;();<a name="line.39"></a>
<span class="sourceLineNo">040</span> for (Method method : set) {<a name="line.40"></a>
<span class="sourceLineNo">041</span> if (!method.isAccessible()) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> method.setAccessible(true);<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> results.put(method, InvocationResult.&lt;T&gt;fromInvocation(method, object, args));<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> return results;<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> public Collection&lt;InvocationResult&lt;T&gt;&gt; invoke(Object... args) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> return map(args).values();<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> public Methods ofReturnType(Class&lt;? extends T&gt; clazz) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> this.returnType = clazz;<a name="line.56"></a>
<span class="sourceLineNo">057</span> return this;<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> public Methods withParameter(Class&lt;?&gt;... type) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> argumentTypes.addAll(Arrays.asList(type));<a name="line.61"></a>
<span class="sourceLineNo">062</span> return this;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> public Methods in(Object o) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.object = o;<a name="line.66"></a>
<span class="sourceLineNo">067</span> this.clazz = o.getClass();<a name="line.67"></a>
<span class="sourceLineNo">068</span> return this;<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> public Methods in(Class&lt;?&gt; c) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> this.clazz = c;<a name="line.72"></a>
<span class="sourceLineNo">073</span> this.object = null;<a name="line.73"></a>
<span class="sourceLineNo">074</span> return this;<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> private Collection&lt;Method&gt; retrieve() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> if (methods != null) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return methods;<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> if (clazz == null) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> throw new NullPointerException("Cannot retrieve method, class not set");<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> methods = new ArrayList&lt;Method&gt;();<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> // First the class itself<a name="line.89"></a>
<span class="sourceLineNo">090</span> Method[] list = clazz.getDeclaredMethods();<a name="line.90"></a>
<span class="sourceLineNo">091</span> for (Method method : list) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> // Two criteria : the return type and the argument type<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (matchReturnType(method)<a name="line.93"></a>
<span class="sourceLineNo">094</span> &amp;&amp; matchArgumentTypes(method)) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> // The method matches<a name="line.95"></a>
<span class="sourceLineNo">096</span> methods.add(method);<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> // Traverse class hierarchy<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (clazz.getSuperclass() != null) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> traverse(methods, clazz.getSuperclass());<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> return methods;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> private boolean matchReturnType(Method method) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (returnType == null) { // Void.<a name="line.109"></a>
<span class="sourceLineNo">110</span> return method.getReturnType() == null;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> return !(method.getReturnType() == null || !returnType.isAssignableFrom(method.getReturnType()));<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> private boolean matchArgumentTypes(Method method) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> // Fast check, the size must be the same.<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (argumentTypes.size() != method.getParameterTypes().length) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return false;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> // We have the same size.<a name="line.122"></a>
<span class="sourceLineNo">123</span> for (int i = 0; i &lt; argumentTypes.size(); i++) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> Class&lt;?&gt; argType = method.getParameterTypes()[i];<a name="line.124"></a>
<span class="sourceLineNo">125</span> if (!argumentTypes.get(i).isAssignableFrom(argType)) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> return false;<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><a name="line.129"></a>
<span class="sourceLineNo">130</span> return true;<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> private boolean matchInheritanceVisibility(Method method) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return Modifier.isPublic(method.getModifiers()) || Modifier.isProtected(method.getModifiers());<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> private boolean matchNotOverridden(Method method, List&lt;Method&gt; methods) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> for (Method meth : methods) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (methodEquality(meth, method)) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return false;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> return true;<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> /**<a name="line.146"></a>
<span class="sourceLineNo">147</span> * Compares this &lt;code&gt;Method&lt;/code&gt; against the specified object. Returns<a name="line.147"></a>
<span class="sourceLineNo">148</span> * true if the objects are the same. Two &lt;code&gt;Methods&lt;/code&gt; are the same if<a name="line.148"></a>
<span class="sourceLineNo">149</span> * they were declared by the same class and have the same name<a name="line.149"></a>
<span class="sourceLineNo">150</span> * and formal parameter types and return type.<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> private boolean methodEquality(Method method1, Method method2) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> if (method1.getName().equals(method2.getName())) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> if (!method1.getReturnType().equals(method2.getReturnType())) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return false;<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> Class[] params1 = method1.getParameterTypes();<a name="line.158"></a>
<span class="sourceLineNo">159</span> Class[] params2 = method2.getParameterTypes();<a name="line.159"></a>
<span class="sourceLineNo">160</span> if (params1.length == params2.length) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> for (int i = 0; i &lt; params1.length; i++) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (params1[i] != params2[i])<a name="line.162"></a>
<span class="sourceLineNo">163</span> return false;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> return true;<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><a name="line.169"></a>
<span class="sourceLineNo">170</span> return false;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> private void traverse(List&lt;Method&gt; methods, Class&lt;?&gt; clazz) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> // First the given class<a name="line.174"></a>
<span class="sourceLineNo">175</span> Method[] list = clazz.getDeclaredMethods();<a name="line.175"></a>
<span class="sourceLineNo">176</span> for (Method method : list) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (matchReturnType(method) &amp;&amp; matchArgumentTypes(method) &amp;&amp; matchInheritanceVisibility(method)<a name="line.177"></a>
<span class="sourceLineNo">178</span> &amp;&amp; matchNotOverridden(method, methods)) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> methods.add(method);<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> // If we have a parent class, traverse it<a name="line.183"></a>
<span class="sourceLineNo">184</span> if (clazz.getSuperclass() != null) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> traverse(methods, clazz.getSuperclass());<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><a name="line.188"></a>
<span class="sourceLineNo">189</span>}<a name="line.189"></a>
</pre>
</div>
</body>
</html>