json.JSONWriter methods

Methods for the json.JSONWriter class.

Table 1. Class method: Creation
Name Description
json.JSONWriter.Create()
  RETURNS json.JSONWriter
Constructor of a JSONWriter object.
Table 2. Object methods: Configuration
Name Description
setOutputCharset(
   charset STRING )
Defines the charset used on the output stream. By default the charset is based on the charset set by the system. For example, on Windows it is Windows-1252, or on some Linux systems it is UTF-8.
Table 3. Object methods: Output
Name Description
writeTo(
   url STRING )
Sets the output stream of the JSONWriter object to a file or an URL, and starts streaming data.
writeToPipe(
   cmd STRING )
Sets the output stream of the JSONWriter object to a PIPE, and starts the streaming.
writeToText(
   txt TEXT )
Sets the output stream of the JSONWriter object to a TEXT large object, and starts the streaming.
setProperty(
   name STRING)
Sets a property of a JSONWriter object.
setValue(
   value AnyType)
Sets the value of a JSONWriter object.
setBooleanValue(
   value BOOLEAN)
Sets a boolean value of a JSONWriter object.
setNullValue()
Sets the null value of a JSONWriter object.
getSize()
  RETURNS INTEGER
Returns the number of bytes written by the JSONWriter in the current stream.
Table 4. Object methods: Stream
Name Description
endJSON()
Closes any open tokens and writes the corresponding end JSON document token.
startJSON()
Begins JSON encoding to the JSONWriter stream.
endObject()
Writes a JSON end object token to the JSONWriter stream.
startObject()
Writes a JSON start object token to the JSONWriter stream.
endArray()
Writes a JSON end array tag to the JSONWriter stream.
startArray()
Writes a JSON start array token to the JSONWriter stream.
close()
Closes the JSONWriter streaming, and releases all associated resources.