Added JavaDocs

This commit is contained in:
Dean 2022-10-07 17:57:07 +01:00
parent 80c1479ad8
commit 9cb8e153bf
No known key found for this signature in database
GPG Key ID: B0FA03846A25C037

View File

@ -755,6 +755,23 @@ public class XML {
return toString(object, tagName, config, 0, 0); return toString(object, tagName, config, 0, 0);
} }
/**
* Convert a JSONObject into a well-formed, element-normal XML string,
* either pretty print or single-lined depending on indent factor.
*
* @param object
* A JSONObject.
* @param tagName
* The optional name of the enclosing tag.
* @param config
* Configuration that can control output to XML.
* @param indentFactor
* The number of spaces to add to each level of indentation.
* @param indent
* The current ident level in spaces.
* @return
* @throws JSONException
*/
private static String toString(final Object object, final String tagName, final XMLParserConfiguration config, int indentFactor, int indent) private static String toString(final Object object, final String tagName, final XMLParserConfiguration config, int indentFactor, int indent)
throws JSONException { throws JSONException {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
@ -934,6 +951,13 @@ public class XML {
return toString(object, tagName, config, indentFactor, 0); return toString(object, tagName, config, indentFactor, 0);
} }
/**
* Return a String consisting of a number of space characters specified by indent
*
* @param indent
* The number of spaces to be appended to the String.
* @return
*/
private static final String indent(int indent) { private static final String indent(int indent) {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
for (int i = 0; i < indent; i++) { for (int i = 0; i < indent; i++) {