argo

Class JsonGenerator

java.lang.Object

argo.JsonGenerator

public final class JsonGenerator
extends java.lang.Object

Provides operations create Strings of valid JSON and to stream valid JSON text to a java.io.Writer.

Instances of this class are immutable, reusable, and thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonGenerator.JsonGeneratorStyle Styles of output a JsonGenerator can produce.

Constructor Summary

Constructors

Constructor and Description
JsonGenerator()

Method Summary

Modifier and Type	Method and Description
java.lang.String	generate(JsonNode jsonNode) Generates a JSON representation of the given JsonNode as a String.
java.lang.String	generate(WriteableJsonArray writeableJsonArray) Generates a JSON representation of the given WriteableJsonArray as a String.
java.lang.String	generate(WriteableJsonNumber writeableJsonNumber) Generates a JSON representation of the given WriteableJsonNumber as a String.
java.lang.String	generate(WriteableJsonObject writeableJsonObject) Generates a JSON representation of the given WriteableJsonObject as a String.
java.lang.String	generate(WriteableJsonString writeableJsonString) Generates a JSON representation of the given WriteableJsonString as a String.
void	generate(java.io.Writer target, JsonNode jsonNode) Streams a JSON representation of the given JsonNode to the given Writer.
void	generate(java.io.Writer target, WriteableJsonArray writeableJsonArray) Streams a JSON representation of the given WriteableJsonArray to the given Writer.
void	generate(java.io.Writer target, WriteableJsonNumber writeableJsonNumber) Streams a JSON representation of the given WriteableJsonNumber to the given Writer.
void	generate(java.io.Writer target, WriteableJsonObject writeableJsonObject) Streams a JSON representation of the given WriteableJsonObject to the given Writer.
void	generate(java.io.Writer target, WriteableJsonString writeableJsonString) Streams a JSON representation of the given WriteableJsonString to the given Writer.
java.lang.String	generateWithFieldSorting(JsonNode jsonNode) Generates a JSON representation of the given JsonNode as a String, outputting fields in lexicographic order.
void	generateWithFieldSorting(java.io.Writer target, JsonNode jsonNode) Streams a JSON representation of the given JsonNode to the given Writer, outputting fields in lexicographic order.
JsonGenerator	style(JsonGenerator.JsonGeneratorStyle style) Returns a JsonGenerator with the given output style.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonGenerator

public JsonGenerator()

Method Detail

generate

public void generate(java.io.Writer target,
                     WriteableJsonArray writeableJsonArray)
              throws java.io.IOException

Streams a JSON representation of the given WriteableJsonArray to the given Writer.

Parameters:

target - the Writer to output to.

writeableJsonArray - the WriteableJsonArray to output.

Throws:

java.io.IOException - if there was a problem writing to the Writer.

generate

public java.lang.String generate(WriteableJsonArray writeableJsonArray)
                          throws java.io.IOException

Generates a JSON representation of the given WriteableJsonArray as a String.

Parameters:

writeableJsonArray - the WriteableJsonArray to output.

Returns:

a JSON representation of the given WriteableJsonArray as a String

Throws:

java.io.IOException - propagated from WriteableJsonArray.writeTo(ArrayWriter).

generate

public void generate(java.io.Writer target,
                     WriteableJsonObject writeableJsonObject)
              throws java.io.IOException

Streams a JSON representation of the given WriteableJsonObject to the given Writer.

Parameters:

target - the Writer to output to.

writeableJsonObject - the WriteableJsonObject to output.

Throws:

java.io.IOException - if there was a problem writing to the Writer.

generate

public java.lang.String generate(WriteableJsonObject writeableJsonObject)
                          throws java.io.IOException

Generates a JSON representation of the given WriteableJsonObject as a String.

Parameters:

writeableJsonObject - the WriteableJsonObject to output.

Returns:

a JSON representation of the given WriteableJsonObject as a String

Throws:

java.io.IOException - propagated from WriteableJsonObject.writeTo(ObjectWriter).

generate

public void generate(java.io.Writer target,
                     WriteableJsonString writeableJsonString)
              throws java.io.IOException

Streams a JSON representation of the given WriteableJsonString to the given Writer.

Parameters:

target - the Writer to output to.

writeableJsonString - the WriteableJsonString to output.

Throws:

java.io.IOException - if there was a problem writing to the Writer.

generate

public java.lang.String generate(WriteableJsonString writeableJsonString)
                          throws java.io.IOException

Generates a JSON representation of the given WriteableJsonString as a String.

Parameters:

writeableJsonString - the WriteableJsonString to output.

Returns:

a JSON representation of the given WriteableJsonString as a String

Throws:

java.io.IOException - propagated from WriteableJsonString.writeTo(Writer).

generate

public void generate(java.io.Writer target,
                     WriteableJsonNumber writeableJsonNumber)
              throws java.io.IOException

Streams a JSON representation of the given WriteableJsonNumber to the given Writer.

Parameters:

target - the Writer to output to.

writeableJsonNumber - the WriteableJsonNumber to output.

Throws:

java.io.IOException - if there was a problem writing to the Writer.

java.lang.IllegalArgumentException - if the characters written by the WriteableJsonNumber don't constitute a complete JSON number.

generate

public java.lang.String generate(WriteableJsonNumber writeableJsonNumber)
                          throws java.io.IOException

Generates a JSON representation of the given WriteableJsonNumber as a String.

Parameters:

writeableJsonNumber - the WriteableJsonNumber to output.

Returns:

a JSON representation of the given WriteableJsonNumber as a String

Throws:

java.io.IOException - propagated from WriteableJsonNumber.writeTo(Writer).

java.lang.IllegalArgumentException - if the characters written by the WriteableJsonNumber don't constitute a complete JSON number.

generate

public void generate(java.io.Writer target,
                     JsonNode jsonNode)
              throws java.io.IOException

Streams a JSON representation of the given JsonNode to the given Writer.

Parameters:

target - the Writer to output to.

jsonNode - the JsonNode to output.

Throws:

java.io.IOException - if there was a problem writing to the Writer.

generate

public java.lang.String generate(JsonNode jsonNode)

Generates a JSON representation of the given JsonNode as a String.

Parameters:

jsonNode - the JsonNode to output.

Returns:

a JSON representation of the given JsonNode as a String

generateWithFieldSorting

public void generateWithFieldSorting(java.io.Writer target,
                                     JsonNode jsonNode)
                              throws java.io.IOException

Streams a JSON representation of the given JsonNode to the given Writer, outputting fields in lexicographic order. JSON does not mandate a particular ordering for the fields of an object, but for comparing JSON documents it can be convenient for field order to be consistent. In the event that more than one field with the same name exists in an object, the relative order of those fields is preserved.

Parameters:

target - the Writer to output to.

jsonNode - the JsonNode to output.

Throws:

java.io.IOException - if there was a problem writing to the Writer.

generateWithFieldSorting

public java.lang.String generateWithFieldSorting(JsonNode jsonNode)

Generates a JSON representation of the given JsonNode as a String, outputting fields in lexicographic order. JSON does not mandate a particular ordering for the fields of an object, but for comparing JSON documents it can be convenient for field order to be consistent. In the event that more than one field with the same name exists in an object, the relative order of those fields is preserved.

Parameters:

jsonNode - the JsonNode to output.

Returns:

a JSON representation of the given JsonNode as a String

style

public JsonGenerator style(JsonGenerator.JsonGeneratorStyle style)

Returns a JsonGenerator with the given output style. Defaults to JsonGenerator.JsonGeneratorStyle.PRETTY.

Parameters:

style - the style of output to produce.

Returns:

a JsonGenerator with the given output style.