Google Git
Sign in
apache / felix-site-pub / ce5028da261c6ed2e1928e6338c81e1f24559823 / . / ipojo / api / 1.12.0 / src-html / org / apache / felix / ipojo / manipulator / metadata / annotation / visitor / util / Names.html
blob: c4918ad5838142e653f23ea64f205363a275c79b [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.util;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Arrays;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Dictionary;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.felix.ipojo.manipulation.ClassManipulator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.objectweb.asm.Type;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.objectweb.asm.tree.MethodNode;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class Names {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Excluded types when searching for a specification interface in method's arguments.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static List&lt;Type&gt; EXCLUSIONS = new ArrayList&lt;Type&gt;();<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> static {<a name="line.42"></a>
<span class="sourceLineNo">043</span> EXCLUSIONS.add(Type.getType(Map.class));<a name="line.43"></a>
<span class="sourceLineNo">044</span> EXCLUSIONS.add(Type.getType(Dictionary.class));<a name="line.44"></a>
<span class="sourceLineNo">045</span> EXCLUSIONS.add(Type.getType("Lorg/osgi/framework/ServiceReference;"));<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> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Computes the real method name. This method is useful when the annotation is collected on an manipulated method<a name="line.49"></a>
<span class="sourceLineNo">050</span> * (prefixed by &lt;code&gt;__M_&lt;/code&gt;). This method just removes the prefix if found.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @param name the collected method name<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @return the effective method name, can be the collected method name if the method name does not start with<a name="line.52"></a>
<span class="sourceLineNo">053</span> * the prefix.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static String computeEffectiveMethodName(String name) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> if (name != null &amp;&amp; name.startsWith(ClassManipulator.PREFIX)) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> return name.substring(ClassManipulator.PREFIX.length());<a name="line.57"></a>
<span class="sourceLineNo">058</span> } else {<a name="line.58"></a>
<span class="sourceLineNo">059</span> return name;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Extract an identifier from the given method name.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * It removes some pre-defined prefixes ({@literal bind}, {@literal unbind},<a name="line.65"></a>
<span class="sourceLineNo">066</span> * {@literal set}, {@literal unset}, {@literal modified}).<a name="line.66"></a>
<span class="sourceLineNo">067</span> *<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @param method method's name<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @return the method's identifier<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> public static String getMethodIdentifier(final MethodNode method) {<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> String effectiveName = computeEffectiveMethodName(method.name);<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> if (effectiveName.startsWith("bind")) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> return effectiveName.substring("bind".length());<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> if (effectiveName.startsWith("set")) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> return effectiveName.substring("set".length());<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> if (effectiveName.startsWith("unbind")) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return effectiveName.substring("unbind".length());<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> if (effectiveName.startsWith("unset")) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return effectiveName.substring("unset".length());<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> if (effectiveName.startsWith("modified")) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return effectiveName.substring("modified".length());<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> if (effectiveName.startsWith("add")) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> return effectiveName.substring("add".length());<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> if (effectiveName.startsWith("remove")) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return effectiveName.substring("remove".length());<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> // Try to discover the specification's type from method's parameters' type<a name="line.103"></a>
<span class="sourceLineNo">104</span> Type[] arguments = Type.getArgumentTypes(method.desc);<a name="line.104"></a>
<span class="sourceLineNo">105</span> return findSpecification(Arrays.asList(arguments));<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><a name="line.108"></a>
<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
<span class="sourceLineNo">110</span> * Find the first type that was not excluded and consider it as the specification<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @param types method parameter's type<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @return the first non-excluded type or {@literal null} if no specification can be found<a name="line.112"></a>
<span class="sourceLineNo">113</span> */<a name="line.113"></a>
<span class="sourceLineNo">114</span> private static String findSpecification(final List&lt;Type&gt; types) {<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> // Find first non-excluded specification<a name="line.116"></a>
<span class="sourceLineNo">117</span> // May return null if no specification is provided (likely a user error)<a name="line.117"></a>
<span class="sourceLineNo">118</span> for (Type type : types) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (!EXCLUSIONS.contains(type)) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return type.getClassName();<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<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> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Check if the given annotation descriptor is an iPOJO custom annotation.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * A valid iPOJO custom annotation must contains 'ipojo' or 'handler' in its qualified name.<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @param desc annotation descriptor<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @return {@literal true} if the given descriptor is an iPOJO custom annotation<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> public static boolean isCustomAnnotation(final String desc) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> String lowerCase = desc.toLowerCase();<a name="line.133"></a>
<span class="sourceLineNo">134</span> return lowerCase.contains("ipojo") || lowerCase.contains("handler");<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>
</pre>
</div>
</body>
</html>