Package org.apache.tapestry5.json

Class JSONCollection

java.lang.Object

org.apache.tapestry5.json.JSONCollection

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JSONArray, JSONObject

public abstract class JSONCollection
extends Object
implements Serializable

Base class for JSONArray and JSONObject that exists to organize the code for printing such objects (either compact or pretty).

Since:

5.2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JSONCollection()

Method Summary

Modifier and Type	Method	Description
void	prettyPrint(PrintWriter writer)	Prints the JSONObject to the writer using indentation (two spaces per indentation level).
void	print(PrintWriter writer)	Prints the JSONObject to the writer compactly (with no extra whitespace).
void	print(PrintWriter writer, boolean compact)	Prints the JSONObject to the write (compactly or not).
String	toCompactString()	Prints the JSONObject as a compact string (not extra punctuation).
String	toString()	Converts this JSON collection into a parsable string representation.
String	toString(boolean compact)	Converts the JSONObject to a compact or pretty-print string representation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JSONCollection

public JSONCollection()

Method Detail

toString

public String toString()

Converts this JSON collection into a parsable string representation. Warning: This method assumes that the data structure is acyclical. Starting in release 5.2, the result will be pretty printed for readability.

Overrides:

toString in class Object

Returns:

a printable, displayable, portable, transmittable representation of the object, beginning with { (left brace) and ending with } (right brace).

toString

public String toString(boolean compact)

Converts the JSONObject to a compact or pretty-print string representation

Parameters:

compact - if true, return minimal format string.

Since:

5.2.0

toCompactString

public String toCompactString()

Prints the JSONObject as a compact string (not extra punctuation). This is, essentially, what Tapestry 5.1 did inside toString().

print

public void print(PrintWriter writer,
                  boolean compact)

Prints the JSONObject to the write (compactly or not).

Parameters:

writer - to write content to

compact - if true, then write compactly, if false, write with pretty printing

Since:

5.2.1

print

public void print(PrintWriter writer)

Prints the JSONObject to the writer compactly (with no extra whitespace).

prettyPrint

public void prettyPrint(PrintWriter writer)

Prints the JSONObject to the writer using indentation (two spaces per indentation level).