| <!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 or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.util;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.lang.reflect.Field;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.lang.reflect.GenericArrayType;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.lang.reflect.ParameterizedType;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.lang.reflect.Type;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.lang.reflect.WildcardType;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.ArrayList;<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.Objects;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Utility class for working with Java {@link Type}s and derivatives. This class is adapted heavily from the<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <a href="http://projects.spring.io/spring-framework/">Spring Framework</a>, specifically the<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <a href="http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/util/TypeUtils.html">TypeUtils</a><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * class.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> *<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @see java.lang.reflect.Type<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @see java.lang.reflect.GenericArrayType<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @see java.lang.reflect.ParameterizedType<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @see java.lang.reflect.WildcardType<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @see java.lang.Class<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @since 2.1<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public final class TypeUtil {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private TypeUtil() {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> }<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Gets all declared fields for the given class (including superclasses).<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param cls the class to examine<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @return all declared fields for the given class (including superclasses).<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @see Class#getDeclaredFields()<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public static List<Field> getAllDeclaredFields(Class<?> cls) {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> final List<Field> fields = new ArrayList<>();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> while (cls != null) {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> for (final Field field : cls.getDeclaredFields()) {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> fields.add(field);<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> }<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> cls = cls.getSuperclass();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> return fields;<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> * Indicates if two {@link Type}s are assignment compatible.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param lhs the left hand side to check assignability to<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param rhs the right hand side to check assignability from<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @return {@code true} if it is legal to assign a variable of type {@code rhs} to a variable of type {@code lhs}<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @see Class#isAssignableFrom(Class)<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static boolean isAssignable(final Type lhs, final Type rhs) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> Objects.requireNonNull(lhs, "No left hand side type provided");<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> Objects.requireNonNull(rhs, "No right hand side type provided");<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> if (lhs.equals(rhs)) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return true;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> if (Object.class.equals(lhs)) {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> // everything is assignable to Object<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return true;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // raw type on left<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> if (lhs instanceof Class<?>) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> final Class<?> lhsClass = (Class<?>) lhs;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> if (rhs instanceof Class<?>) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> // no generics involved<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> final Class<?> rhsClass = (Class<?>) rhs;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> return lhsClass.isAssignableFrom(rhsClass);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (rhs instanceof ParameterizedType) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> // check to see if the parameterized type has the same raw type as the lhs; this is legal<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> final Type rhsRawType = ((ParameterizedType) rhs).getRawType();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (rhsRawType instanceof Class<?>) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return lhsClass.isAssignableFrom((Class<?>) rhsRawType);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> if (lhsClass.isArray() && rhs instanceof GenericArrayType) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> // check for compatible array component types<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return isAssignable(lhsClass.getComponentType(), ((GenericArrayType) rhs).getGenericComponentType());<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> // parameterized type on left<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (lhs instanceof ParameterizedType) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> final ParameterizedType lhsType = (ParameterizedType) lhs;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> if (rhs instanceof Class<?>) {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> final Type lhsRawType = lhsType.getRawType();<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> if (lhsRawType instanceof Class<?>) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return ((Class<?>) lhsRawType).isAssignableFrom((Class<?>) rhs);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> } else if (rhs instanceof ParameterizedType) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> final ParameterizedType rhsType = (ParameterizedType) rhs;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return isParameterizedAssignable(lhsType, rhsType);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> // generic array type on left<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> if (lhs instanceof GenericArrayType) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> final Type lhsComponentType = ((GenericArrayType) lhs).getGenericComponentType();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> if (rhs instanceof Class<?>) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> // raw type on right<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> final Class<?> rhsClass = (Class<?>) rhs;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> if (rhsClass.isArray()) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return isAssignable(lhsComponentType, rhsClass.getComponentType());<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> } else if (rhs instanceof GenericArrayType) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return isAssignable(lhsComponentType, ((GenericArrayType) rhs).getGenericComponentType());<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> // wildcard type on left<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> if (lhs instanceof WildcardType) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return isWildcardAssignable((WildcardType) lhs, rhs);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> // strange...<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return false;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> private static boolean isParameterizedAssignable(final ParameterizedType lhs, final ParameterizedType rhs) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (lhs.equals(rhs)) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> // that was easy<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> return true;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> final Type[] lhsTypeArguments = lhs.getActualTypeArguments();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> final Type[] rhsTypeArguments = rhs.getActualTypeArguments();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> final int size = lhsTypeArguments.length;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> if (rhsTypeArguments.length != size) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> // clearly incompatible types<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return false;<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> for (int i = 0; i < size; i++) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> // verify all type arguments are assignable<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> final Type lhsArgument = lhsTypeArguments[i];<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> final Type rhsArgument = rhsTypeArguments[i];<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> if (!lhsArgument.equals(rhsArgument) &&<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> !(lhsArgument instanceof WildcardType &&<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> isWildcardAssignable((WildcardType) lhsArgument, rhsArgument))) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return false;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> return true;<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> private static boolean isWildcardAssignable(final WildcardType lhs, final Type rhs) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> final Type[] lhsUpperBounds = getEffectiveUpperBounds(lhs);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> final Type[] lhsLowerBounds = getEffectiveLowerBounds(lhs);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> if (rhs instanceof WildcardType) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> // oh boy, this scenario requires checking a lot of assignability!<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> final WildcardType rhsType = (WildcardType) rhs;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> final Type[] rhsUpperBounds = getEffectiveUpperBounds(rhsType);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> final Type[] rhsLowerBounds = getEffectiveLowerBounds(rhsType);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> for (final Type lhsUpperBound : lhsUpperBounds) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> for (final Type rhsUpperBound : rhsUpperBounds) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (!isBoundAssignable(lhsUpperBound, rhsUpperBound)) {<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> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> for (final Type rhsLowerBound : rhsLowerBounds) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> if (!isBoundAssignable(lhsUpperBound, rhsLowerBound)) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return false;<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> for (final Type lhsLowerBound : lhsLowerBounds) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> for (final Type rhsUpperBound : rhsUpperBounds) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> if (!isBoundAssignable(rhsUpperBound, lhsLowerBound)) {<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> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> for (final Type rhsLowerBound : rhsLowerBounds) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> if (!isBoundAssignable(rhsLowerBound, lhsLowerBound)) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return false;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> } else {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> // phew, far less bounds to check<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> for (final Type lhsUpperBound : lhsUpperBounds) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> if (!isBoundAssignable(lhsUpperBound, rhs)) {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> return false;<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> |
| <span class="sourceLineNo">199</span> for (final Type lhsLowerBound : lhsLowerBounds) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> if (!isBoundAssignable(lhsLowerBound, rhs)) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> return false;<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<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> return true;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> private static Type[] getEffectiveUpperBounds(final WildcardType type) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> final Type[] upperBounds = type.getUpperBounds();<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> return upperBounds.length == 0 ? new Type[]{Object.class} : upperBounds;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> private static Type[] getEffectiveLowerBounds(final WildcardType type) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> final Type[] lowerBounds = type.getLowerBounds();<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> return lowerBounds.length == 0 ? new Type[]{null} : lowerBounds;<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> private static boolean isBoundAssignable(final Type lhs, final Type rhs) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return (rhs == null) || ((lhs != null) && isAssignable(lhs, rhs));<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span>}<a name="line.221"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
