etan39
/
cloudstack
mirror of https://github.com/apache/cloudstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Modified API xml doc writer - sort request and response parameters in alphabetical order.

This commit is contained in:
alena 2011-01-14 11:16:47 -08:00
parent 046c556da1
commit 5af31fc97c
2 changed files with 49 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
server/src/com/cloud/api/doc/ApiXmlDocWriter.java
View File

@ -264,6 +264,9 @@ public class ApiXmlDocWriter {
private static ArrayList<Argument> setRequestFields(Field[] fields) {
ArrayList<Argument> arguments = new ArrayList<Argument>();
ArrayList<Argument> requiredArguments = new ArrayList<Argument>();
ArrayList<Argument> optionalArguments = new ArrayList<Argument>();
Argument id = null;
for (Field f : fields) {
Parameter parameterAnnotation = f.getAnnotation(Parameter.class);
if (parameterAnnotation != null && parameterAnnotation.expose()) {
@ -272,14 +275,37 @@ public class ApiXmlDocWriter {
if (!parameterAnnotation.description().isEmpty()) {
reqArg.setDescription(parameterAnnotation.description());
}
arguments.add(reqArg);
if (reqArg.isRequired() == true) {
if (parameterAnnotation.name().equals("id")) {
id = reqArg;
} else {
requiredArguments.add(reqArg);
}
} else {
optionalArguments.add(reqArg);
}
}
}
Collections.sort(requiredArguments);
Collections.sort(optionalArguments);
//sort required and optional arguments here
if (id != null) {
arguments.add(id);
}
arguments.addAll(requiredArguments);
arguments.addAll(optionalArguments);
return arguments;
}
private static ArrayList<Argument> setResponseFields(Field[] responseFields) {
ArrayList<Argument> arguments = new ArrayList<Argument>();
ArrayList<Argument> sortedArguments = new ArrayList<Argument>();
Argument id = null;
for (Field responseField : responseFields) {
SerializedName nameAnnotation = responseField.getAnnotation(SerializedName.class);
Param paramAnnotation = responseField.getAnnotation(Param.class);
@ -308,11 +334,20 @@ public class ApiXmlDocWriter {
}
if (toExpose) {
arguments.add(respArg);
}
if (nameAnnotation.value().equals("id")) {
id = respArg;
} else {
sortedArguments.add(respArg);
}
}
}
Collections.sort(sortedArguments);
if (id != null) {
arguments.add(id);
}
arguments.addAll(sortedArguments);
return arguments;
}

10
server/src/com/cloud/api/doc/Argument.java
View File

@ -20,7 +20,7 @@ package com.cloud.api.doc;
import java.util.List;
public class Argument{
public class Argument implements Comparable{
private String name;
private String description;
private Boolean required;
@ -56,4 +56,12 @@ public class Argument{
public void setArguments(List<Argument> arguments) {
this.arguments = arguments;
}
public int compareTo(Object anotherAgrument) throws ClassCastException {
if (!(anotherAgrument instanceof Argument))
throw new ClassCastException("An Argument object expected.");
Argument argument = (Argument)anotherAgrument;
return this.getName().compareToIgnoreCase(argument.getName());
}
}