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
|
// Copyright 2014 Google Inc. 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.Preconditions;
import com.google.devtools.build.lib.syntax.SkylarkModule;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
/**
* A class representing a Skylark built-in object with its {@link SkylarkSignature} annotation
* and the {@link SkylarkCallable} methods it might have.
*/
public final class SkylarkModuleDoc extends SkylarkDoc {
private final SkylarkModule module;
private final Class<?> classObject;
private final Map<String, SkylarkBuiltinMethodDoc> builtinMethodMap;
private ArrayList<SkylarkJavaMethodDoc> javaMethods;
private TreeMap<String, SkylarkMethodDoc> methodMap;
private String title;
public SkylarkModuleDoc(SkylarkModule module, Class<?> classObject) {
this.module = Preconditions.checkNotNull(
module, "Class has to be annotated with SkylarkModule: %s", classObject);
this.classObject = classObject;
this.builtinMethodMap = new TreeMap<>();
this.methodMap = new TreeMap<>();
this.javaMethods = new ArrayList<>();
this.title = module.name();
}
@Override
public String getName() {
return module.name();
}
@Override
public String getDocumentation() {
return module.doc();
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public SkylarkModule getAnnotation() {
return module;
}
public Class<?> getClassObject() {
return classObject;
}
public void addMethod(SkylarkBuiltinMethodDoc method) {
methodMap.put(method.getName(), method);
builtinMethodMap.put(method.getName(), method);
}
public void addMethod(SkylarkJavaMethodDoc method) {
methodMap.put(method.getName() + "$" + method.getMethod().getParameterTypes().length, method);
javaMethods.add(method);
}
public boolean javaMethodsNotCollected() {
return javaMethods.isEmpty();
}
public Map<String, SkylarkBuiltinMethodDoc> getBuiltinMethods() {
return builtinMethodMap;
}
public List<SkylarkJavaMethodDoc> getJavaMethods() {
return javaMethods;
}
public Collection<SkylarkMethodDoc> getMethods() {
return methodMap.values();
}
}
|
