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
|
// Copyright 2014 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.docgen.skylark;
import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
/**
* A class representing a Java method callable from Skylark with annotation.
*/
public final class SkylarkJavaMethodDoc extends SkylarkMethodDoc {
private final String moduleName;
private final String name;
private final Method method;
private final SkylarkCallable callable;
private final ImmutableList<SkylarkParamDoc> params;
private boolean isOverloaded;
public SkylarkJavaMethodDoc(String moduleName, Method method, SkylarkCallable callable) {
this.moduleName = moduleName;
this.name = callable.name();
this.method = method;
this.callable = callable;
this.params =
SkylarkDocUtils.determineParams(
this,
withoutSelfParam(callable, method),
callable.extraPositionals(),
callable.extraKeywords());
}
public Method getMethod() {
return method;
}
@Override
public boolean documented() {
return callable.documented();
}
@Override
public String getName() {
// Normally we refer to methods by their name, e.g. "foo" for method foo(arg1, arg2).
// However, if a method is overloaded, the name is no longer unique, which forces us to append
// the names of the method parameters in order to get a unique value.
// In this case, the return value for the previous example would be "foo(arg1, arg2)".
// We decided against ALWAYS returning the full name since we didn't want to pollute the
// TOC of documentation pages too much. This comes at the cost of inconsistency and more
// complex code.
return isOverloaded ? getFullName() : name;
}
/**
* Returns the full name of the method, consisting of
* <method name>(<name of first param>, <name of second param>, ...).
*/
private String getFullName() {
List<String> paramNames = new ArrayList<>();
for (Param param : callable.parameters()) {
paramNames.add(param.name());
}
return String.format("%s(%s)", name, Joiner.on(", ").join(paramNames));
}
@Override
public String getDocumentation() {
return SkylarkDocUtils.substituteVariables(callable.doc());
}
@Override
public String getSignature() {
return getSignature(moduleName, name, method);
}
@Override
public String getReturnTypeExtraMessage() {
if (callable.allowReturnNones()) {
return " May return <code>None</code>.\n";
}
return "";
}
@Override
public List<SkylarkParamDoc> getParams() {
return params;
}
public void setOverloaded(boolean isOverloaded) {
this.isOverloaded = isOverloaded;
}
}
|
