1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Copyright 2016 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.skylarkinterface;
import java.lang.reflect.Method;
import javax.annotation.Nullable;
/**
* Helpers for accessing Skylark interface annotations.
*/
public class SkylarkInterfaceUtils {
private static final class ClassAndSkylarkModule {
final Class<?> klass;
final SkylarkModule skylarkModule;
ClassAndSkylarkModule(Class<?> klass, SkylarkModule skylarkModule) {
this.klass = klass;
this.skylarkModule = skylarkModule;
}
}
@Nullable
private static ClassAndSkylarkModule searchForSkylarkModule(Class<?> classObj) {
if (classObj.isAnnotationPresent(SkylarkModule.class)) {
return new ClassAndSkylarkModule(classObj, classObj.getAnnotation(SkylarkModule.class));
}
Class<?> superclass = classObj.getSuperclass();
if (superclass != null) {
ClassAndSkylarkModule result = searchForSkylarkModule(superclass);
if (result != null) {
return result;
}
}
for (Class<?> interfaceObj : classObj.getInterfaces()) {
ClassAndSkylarkModule result = searchForSkylarkModule(interfaceObj);
if (result != null) {
return result;
}
}
return null;
}
/**
* Returns the {@link SkylarkModule} annotation for the given class, if it exists, and
* null otherwise. The first annotation found will be returned, starting with {@code classObj}
* and following its base classes and interfaces recursively.
*/
@Nullable
public static SkylarkModule getSkylarkModule(Class<?> classObj) {
ClassAndSkylarkModule result = searchForSkylarkModule(classObj);
return result == null ? null : result.skylarkModule;
}
/**
* Searches {@code classObj}'s class hierarchy and returns the first superclass or interface that
* is annotated with {@link SkylarkModule} (including possibly {@code classObj} itself), or null
* if none is found.
*/
@Nullable
public static Class<?> getParentWithSkylarkModule(Class<?> classObj) {
ClassAndSkylarkModule result = searchForSkylarkModule(classObj);
return result == null ? null : result.klass;
}
/**
* Returns the {@link SkylarkCallable} annotation for the given method, if it exists, and
* null otherwise. The first annotation of an overridden version of the method that is found
* will be returned, starting with {@code classObj} and following its base classes and
* interfaces recursively, skipping any annotation inside a class not marked
* {@link SkylarkModule}.
*/
@Nullable
public static SkylarkCallable getSkylarkCallable(Class<?> classObj, Method method) {
try {
Method superMethod = classObj.getMethod(method.getName(), method.getParameterTypes());
if (classObj.isAnnotationPresent(SkylarkModule.class)
&& superMethod.isAnnotationPresent(SkylarkCallable.class)) {
return superMethod.getAnnotation(SkylarkCallable.class);
}
} catch (NoSuchMethodException e) {
// The class might not have the specified method, so an exception is OK.
}
if (classObj.getSuperclass() != null) {
SkylarkCallable annotation = getSkylarkCallable(classObj.getSuperclass(), method);
if (annotation != null) {
return annotation;
}
}
for (Class<?> interfaceObj : classObj.getInterfaces()) {
SkylarkCallable annotation = getSkylarkCallable(interfaceObj, method);
if (annotation != null) {
return annotation;
}
}
return null;
}
/**
* Convenience version of {@code getAnnotationsFromParentClass(Class, Method)} that uses
* the declaring class of the method.
*/
@Nullable
public static SkylarkCallable getSkylarkCallable(Method method) {
return getSkylarkCallable(method.getDeclaringClass(), method);
}
}
|
