Pretty print XML

[DeaneOC]

This feature was requested some time ago on #593, there are now methods that allow users to pass an indentFactorto the toString methods in the XML class and this will return a Pretty Printer XML String with spaces based on indentFactor.

This is done similarly to the JSONObject model.

Previous XML result with no indentFactor specified:
<employee><name>sonoo</name><salary>56000</salary><married>true</married></employee>

New result with indentFactor set as 2:

<employee>
  <name>sonoo</name>
  <salary>56000</salary>
  <married>true</married>
</employee>

Contributed on behalf of the @opencastsoftware open source team. 👋

[stleary]

@DeaneOC Nice work. Can you please make the following changes?

• New methods should have JavaDocs, especially for new parameters.
• Make sure new methods actually need to be public, or else use more restrictive access.
• Unit test very large strings should be stored in src/test/resources. You can search for 'issue537' for an example of how to do this.

[DeaneOC]

@DeaneOC Nice work. Can you please make the following changes?

• New methods should have JavaDocs, especially for new parameters.
• Make sure new methods actually need to be public, or else use more restrictive access.
• Unit test very large strings should be stored in src/test/resources. You can search for 'issue537' for an example of how to do this.

Thanks @stleary

In terms of point one and two, I have JavaDoc comments on the three new methods that are public:

toString(object, indentFactor)
toString(object, tagLine, indentFactor)
toString(object, tagline, config, indentFactor)

You can currently call toString three different ways so I thought three new public methods that can also take an indent factor were appropriate.

The two methods below are private as users should not be able to call them directly, so I have not added JavaDocs, if you would like me to do so let me know:

toString(object, tagline, config, indentFactor, indent)
indent(indent)

I believe the current restrictions on method access are correct, three public and two private as mentioned above but if you believe otherwise let me know.

Point 3: I have altered test three to use the resource, I was aware it was very long so very happy to make that change.

Thanks for getting back to me so quickly and let me know what you think about the above comments so I can make and required changes.

[stleary]

@DeaneOC Thanks for the update. Yes, please add Javadocs to all new methods, not just the public ones.

[DeaneOC]

@DeaneOC Thanks for the update. Yes, please add Javadocs to all new methods, not just the public ones.

Javadocs added. Thanks @stleary

[stleary]

Changes look good, but one of the new unit tests is failing when run from a Windows box:
org.json.junit.XMLTest > testIndentComplicatedJsonObjectWithArrayAndWithConfig FAILED org.junit.ComparisonFailure at XMLTest.java:1235

[DeaneOC]

Changes look good, but one of the new unit tests is failing when run from a Windows box: org.json.junit.XMLTest > testIndentComplicatedJsonObjectWithArrayAndWithConfig FAILED org.junit.ComparisonFailure at XMLTest.java:1235

Hi, it was to do with the System (mac vs windows) line separators being different. It has now been updated to work for both. Thanks @stleary

[stleary]

What problem does this code solve?
Add support for XML pretty print

Risks
Low

Changes to the API?
New public API methods

Will this require a new release?
No

Should the documentation be updated?
No

Does it break the unit tests?
No. Unit tests were added.

Was any code refactored in this commit?
No

Review status
APPROVED

Starting 3-day comment window

[javadev]

It will be better to replace the system out with assert.

[stleary]

@javadev Can you clarify where you saw this in the code? I cannot find it.

[javadev]

You are right, the code is outdated. The current implementation has assertEquals.