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

Changed response format in xml api doc generator

This commit is contained in:
alena 2011-01-14 16:14:42 -08:00
parent d59358dd09
commit 0d2be33b2d
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -303,7 +303,9 @@ public class ApiXmlDocWriter {
private static ArrayList<Argument> setResponseFields(Field[] responseFields) {
ArrayList<Argument> arguments = new ArrayList<Argument>();
ArrayList<Argument> sortedChildlessArguments = new ArrayList<Argument>();
ArrayList<Argument> sortedArguments = new ArrayList<Argument>();
Argument id = null;
for (Field responseField : responseFields) {
@ -311,6 +313,7 @@ public class ApiXmlDocWriter {
Param paramAnnotation = responseField.getAnnotation(Param.class);
Argument respArg = new Argument(nameAnnotation.value());
boolean toExpose = true;
boolean hasChildren = false;
if (paramAnnotation != null) {
String description = paramAnnotation.description();
Class fieldClass = paramAnnotation.responseObject();
@ -328,6 +331,7 @@ public class ApiXmlDocWriter {
Field[] fields = fieldClass.getDeclaredFields();
fieldArguments = setResponseFields(fields);
respArg.setArguments(fieldArguments);
hasChildren = true;
}
}
}
@ -337,16 +341,23 @@ public class ApiXmlDocWriter {
if (nameAnnotation.value().equals("id")) {
id = respArg;
} else {
sortedArguments.add(respArg);
if (hasChildren) {
respArg.setName(nameAnnotation.value() + "(*)");
sortedArguments.add(respArg);
} else {
sortedChildlessArguments.add(respArg);
}
}
}
}
Collections.sort(sortedArguments);
Collections.sort(sortedChildlessArguments);
if (id != null) {
arguments.add(id);
}
arguments.addAll(sortedChildlessArguments);
arguments.addAll(sortedArguments);
return arguments;
}

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

@ -62,6 +62,10 @@ public class Argument implements Comparable{
throw new ClassCastException("An Argument object expected.");
Argument argument = (Argument)anotherAgrument;
return this.getName().compareToIgnoreCase(argument.getName());
}
}
public boolean hasArguments() {
return (arguments!= null && !arguments.isEmpty());
}
}