private void scanForMultipart(
ExecutableElement executableElement, RestDocumentation.Resource.Method doc) {
for (VariableElement var : executableElement.getParameters()) {
TypeMirror varType = var.asType();
if (varType.toString().startsWith(MultipartHttpServletRequest.class.getName())) {
doc.setMultipartRequest(true);
return;
}
}
}
private void processRequestMappingMethod(ExecutableElement executableElement) {
TypeElement cls = (TypeElement) executableElement.getEnclosingElement();
String path = getClassLevelUrlPath(cls);
RequestMapping anno = executableElement.getAnnotation(RequestMapping.class);
path = addMethodPathComponent(executableElement, cls, path, anno);
RequestMethod meth = getRequestMethod(executableElement, cls, anno);
RestDocumentation.Resource.Method doc =
_docs.getResourceDocumentation(path).newMethodDocumentation(meth);
String docComment = processingEnv.getElementUtils().getDocComment(executableElement);
if (StringUtils.isNotBlank(docComment)) {
MethodStructure methodStructure = generateMethodStructure(docComment);
doc.setCommentText(generateJavaDocHTML(methodStructure));
doc.setCommentSummary(methodStructure.getDescription());
}
buildParameterData(executableElement, doc);
buildResponseFormat(executableElement.getReturnType(), doc);
}
private RequestMethod getRequestMethod(
ExecutableElement executableElement, TypeElement cls, RequestMapping anno) {
if (anno.method().length != 1) {
throw new IllegalStateException(
String.format(
"The RequestMapping annotation for %s.%s is not parseable. Exactly one request method (GET/POST/etc) is required.",
cls.getQualifiedName(), executableElement.getSimpleName()));
} else {
return anno.method()[0];
}
}
private void buildUrlParameters(
ExecutableElement executableElement, RestDocumentation.Resource.Method doc) {
RestDocumentation.Resource.Method.UrlFields subs = doc.getUrlParameters();
for (VariableElement var : executableElement.getParameters()) {
RequestParam reqParam = var.getAnnotation(RequestParam.class);
if (reqParam != null) {
addUrlField(subs, var, reqParam.value());
}
}
}
private void buildPathVariables(
ExecutableElement executableElement, RestDocumentation.Resource.Method doc) {
RestDocumentation.Resource.Method.UrlFields subs = doc.getUrlSubstitutions();
for (VariableElement var : executableElement.getParameters()) {
PathVariable pathVar = var.getAnnotation(PathVariable.class);
if (pathVar != null) {
addUrlField(subs, var, pathVar.value());
}
}
}
private void buildRequestBodies(
ExecutableElement executableElement, RestDocumentation.Resource.Method doc) {
List<VariableElement> requestBodies = new ArrayList<VariableElement>();
for (VariableElement var : executableElement.getParameters()) {
if (var.getAnnotation(org.springframework.web.bind.annotation.RequestBody.class) != null) {
requestBodies.add(var);
}
}
if (requestBodies.size() > 1) {
throw new IllegalStateException(
String.format(
"Method %s in class %s has multiple @RequestBody params",
executableElement.getSimpleName(), executableElement.getEnclosingElement()));
}
if (requestBodies.size() == 1) {
buildRequestBody(requestBodies.get(0), doc);
}
}
private String addMethodPathComponent(
ExecutableElement executableElement, TypeElement cls, String path, RequestMapping anno) {
if (anno == null) {
throw new IllegalArgumentException(
String.format(
"Method %s should have Request mapping annotation",
executableElement.getSimpleName()));
}
if (anno.value() != null && anno.value().length > 0) {
return Utils.joinPaths(path, anno.value()[0]);
}
return path;
}
private void addFieldFromBeanMethod(JsonObject o, ExecutableElement executableElement) {
if (!isJsonBeanGetter(executableElement)) {
return;
}
TypeMirror type = executableElement.getReturnType();
String methodName = executableElement.getSimpleName().toString();
int trimLength = methodName.startsWith("is") ? 2 : 3;
String beanName = methodName.substring(trimLength + 1, methodName.length());
beanName = methodName.substring(trimLength, trimLength + 1).toLowerCase() + beanName;
// loop over the element's generic types, and build a concrete list from the owning context
List<DeclaredType> concreteTypes = new ArrayList();
// replace variables with the current concrete manifestation
if (type instanceof TypeVariable) {
type = getDeclaredTypeForTypeVariable((TypeVariable) type);
if (type == null) {
return; // couldn't find a replacement -- must be a generics-capable type with no generics
// info
}
}
String docComment = processingEnv.getElementUtils().getDocComment(executableElement);
if (type instanceof DeclaredType) {
TypeElement element = (TypeElement) ((DeclaredType) type).asElement();
for (TypeParameterElement generic : element.getTypeParameters()) {
concreteTypes.add(_typeArguments.get(generic.getSimpleName()));
}
Collection<DeclaredType> types = new HashSet<DeclaredType>(_typeRecursionGuard);
types.add(_type);
o.addField(beanName, newJsonType((DeclaredType) type, concreteTypes, types))
.setCommentText(docComment);
} else {
o.addField(beanName, newJsonType(type)).setCommentText(docComment);
}
}
private boolean isJsonBeanGetter(ExecutableElement executableElement) {
if (executableElement.getKind() != ElementKind.METHOD) {
return false;
}
if (executableElement.getReturnType().getKind() == TypeKind.NULL) {
return false;
}
if (!(executableElement.getSimpleName().toString().startsWith("get")
|| executableElement.getSimpleName().toString().startsWith("is"))) {
return false;
}
if (executableElement.getParameters().size() > 0) {
return false;
}
return executableElement.getAnnotation(JsonIgnore.class) == null;
}
