1844
|
1 |
/*
|
|
2 |
* Copyright 2008 Sun Microsystems, Inc. All Rights Reserved.
|
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
4 |
*
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
7 |
* published by the Free Software Foundation. Sun designates this
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
9 |
* by Sun in the LICENSE file that accompanied this code.
|
|
10 |
*
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
15 |
* accompanied this code).
|
|
16 |
*
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
20 |
*
|
|
21 |
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
|
|
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or
|
|
23 |
* have any questions.
|
|
24 |
*/
|
|
25 |
package com.sun.beans.finder;
|
|
26 |
|
|
27 |
import com.sun.beans.WeakCache;
|
|
28 |
|
|
29 |
import java.lang.reflect.Method;
|
|
30 |
import java.lang.reflect.Modifier;
|
|
31 |
|
|
32 |
/**
|
|
33 |
* This utility class provides {@code static} methods
|
|
34 |
* to find a public method with specified name and parameter types
|
|
35 |
* in specified class.
|
|
36 |
*
|
|
37 |
* @since 1.7
|
|
38 |
*
|
|
39 |
* @author Sergey A. Malenkov
|
|
40 |
*/
|
|
41 |
public final class MethodFinder extends AbstractFinder<Method> {
|
|
42 |
private static final WeakCache<Signature, Method> CACHE = new WeakCache<Signature, Method>();
|
|
43 |
|
|
44 |
/**
|
|
45 |
* Finds public method (static or non-static)
|
|
46 |
* that is accessible from public class.
|
|
47 |
*
|
|
48 |
* @param type the class that can have method
|
|
49 |
* @param name the name of method to find
|
|
50 |
* @param args parameter types that is used to find method
|
|
51 |
* @return object that represents found method
|
|
52 |
* @throws NoSuchMethodException if method could not be found
|
|
53 |
* or some methods are found
|
|
54 |
*/
|
|
55 |
public static Method findMethod(Class<?> type, String name, Class<?>...args) throws NoSuchMethodException {
|
|
56 |
if (name == null) {
|
|
57 |
throw new IllegalArgumentException("Method name is not set");
|
|
58 |
}
|
|
59 |
PrimitiveWrapperMap.replacePrimitivesWithWrappers(args);
|
|
60 |
Signature signature = new Signature(type, name, args);
|
|
61 |
|
|
62 |
Method method = CACHE.get(signature);
|
|
63 |
if (method != null) {
|
|
64 |
return method;
|
|
65 |
}
|
|
66 |
method = findAccessibleMethod(new MethodFinder(name, args).find(type.getMethods()));
|
|
67 |
CACHE.put(signature, method);
|
|
68 |
return method;
|
|
69 |
}
|
|
70 |
|
|
71 |
/**
|
|
72 |
* Finds public non-static method
|
|
73 |
* that is accessible from public class.
|
|
74 |
*
|
|
75 |
* @param type the class that can have method
|
|
76 |
* @param name the name of method to find
|
|
77 |
* @param args parameter types that is used to find method
|
|
78 |
* @return object that represents found method
|
|
79 |
* @throws NoSuchMethodException if method could not be found
|
|
80 |
* or some methods are found
|
|
81 |
*/
|
|
82 |
public static Method findInstanceMethod(Class<?> type, String name, Class<?>... args) throws NoSuchMethodException {
|
|
83 |
Method method = findMethod(type, name, args);
|
|
84 |
if (Modifier.isStatic(method.getModifiers())) {
|
|
85 |
throw new NoSuchMethodException("Method '" + name + "' is static");
|
|
86 |
}
|
|
87 |
return method;
|
|
88 |
}
|
|
89 |
|
|
90 |
/**
|
|
91 |
* Finds public static method
|
|
92 |
* that is accessible from public class.
|
|
93 |
*
|
|
94 |
* @param type the class that can have method
|
|
95 |
* @param name the name of method to find
|
|
96 |
* @param args parameter types that is used to find method
|
|
97 |
* @return object that represents found method
|
|
98 |
* @throws NoSuchMethodException if method could not be found
|
|
99 |
* or some methods are found
|
|
100 |
*/
|
|
101 |
public static Method findStaticMethod(Class<?> type, String name, Class<?>...args) throws NoSuchMethodException {
|
|
102 |
Method method = findMethod(type, name, args);
|
|
103 |
if (!Modifier.isStatic(method.getModifiers())) {
|
|
104 |
throw new NoSuchMethodException("Method '" + name + "' is not static");
|
|
105 |
}
|
|
106 |
return method;
|
|
107 |
}
|
|
108 |
|
|
109 |
/**
|
|
110 |
* Finds method that is accessible from public class or interface through class hierarchy.
|
|
111 |
*
|
|
112 |
* @param method object that represents found method
|
|
113 |
* @return object that represents accessible method
|
|
114 |
* @throws NoSuchMethodException if method is not accessible or is not found
|
|
115 |
* in specified superclass or interface
|
|
116 |
*/
|
|
117 |
private static Method findAccessibleMethod(Method method) throws NoSuchMethodException {
|
|
118 |
Class<?> type = method.getDeclaringClass();
|
|
119 |
if (Modifier.isPublic(type.getModifiers())) {
|
|
120 |
return method;
|
|
121 |
}
|
|
122 |
if (Modifier.isStatic(method.getModifiers())) {
|
|
123 |
throw new NoSuchMethodException("Method '" + method.getName() + "' is not accessible");
|
|
124 |
}
|
|
125 |
for (Class<?> face : type.getInterfaces()) {
|
|
126 |
try {
|
|
127 |
return findAccessibleMethod(method, face);
|
|
128 |
}
|
|
129 |
catch (NoSuchMethodException exception) {
|
|
130 |
// try to find in superclass or another interface
|
|
131 |
}
|
|
132 |
}
|
|
133 |
return findAccessibleMethod(method, type.getSuperclass());
|
|
134 |
}
|
|
135 |
|
|
136 |
/**
|
|
137 |
* Finds method that accessible from specified class.
|
|
138 |
*
|
|
139 |
* @param method object that represents found method
|
|
140 |
* @param type class that is used to find accessible method
|
|
141 |
* @return object that represents accessible method
|
|
142 |
* @throws NoSuchMethodException if method is not accessible or is not found
|
|
143 |
* in specified superclass or interface
|
|
144 |
*/
|
|
145 |
private static Method findAccessibleMethod(Method method, Class<?> type) throws NoSuchMethodException {
|
|
146 |
String name = method.getName();
|
|
147 |
Class<?>[] params = method.getParameterTypes();
|
|
148 |
return findAccessibleMethod(type.getMethod(name, params));
|
|
149 |
}
|
|
150 |
|
|
151 |
|
|
152 |
private final String name;
|
|
153 |
|
|
154 |
/**
|
|
155 |
* Creates method finder with specified array of parameter types.
|
|
156 |
*
|
|
157 |
* @param name the name of method to find
|
|
158 |
* @param args the array of parameter types
|
|
159 |
*/
|
|
160 |
private MethodFinder(String name, Class<?>[] args) {
|
|
161 |
super(args);
|
|
162 |
this.name = name;
|
|
163 |
}
|
|
164 |
|
|
165 |
/**
|
|
166 |
* Returns an array of {@code Class} objects
|
|
167 |
* that represent the formal parameter types of the method
|
|
168 |
* Returns an empty array if the method takes no parameters.
|
|
169 |
*
|
|
170 |
* @param method the object that represents method
|
|
171 |
* @return the parameter types of the method
|
|
172 |
*/
|
|
173 |
@Override
|
|
174 |
protected Class<?>[] getParameters(Method method) {
|
|
175 |
return method.getParameterTypes();
|
|
176 |
}
|
|
177 |
|
|
178 |
/**
|
|
179 |
* Returns {@code true} if and only if the method
|
|
180 |
* was declared to take a variable number of arguments.
|
|
181 |
*
|
|
182 |
* @param method the object that represents method
|
|
183 |
* @return {@code true} if the method was declared
|
|
184 |
* to take a variable number of arguments;
|
|
185 |
* {@code false} otherwise
|
|
186 |
*/
|
|
187 |
@Override
|
|
188 |
protected boolean isVarArgs(Method method) {
|
|
189 |
return method.isVarArgs();
|
|
190 |
}
|
|
191 |
|
|
192 |
/**
|
|
193 |
* Checks validness of the method.
|
|
194 |
* The valid method should be public and
|
|
195 |
* should have the specified name.
|
|
196 |
*
|
|
197 |
* @param method the object that represents method
|
|
198 |
* @return {@code true} if the method is valid,
|
|
199 |
* {@code false} otherwise
|
|
200 |
*/
|
|
201 |
@Override
|
|
202 |
protected boolean isValid(Method method) {
|
|
203 |
return Modifier.isPublic(method.getModifiers()) && method.getName().equals(this.name);
|
|
204 |
}
|
|
205 |
}
|