IRISLIB database
Formatter Class Reference

JSON.Formatter implements the ability to format JSON documents which are expressed as strings, text or dynamic objects. More...

Inheritance diagram for Formatter:
Collaboration diagram for Formatter:

Public Member Functions

_.Library.Status Format (input)
 JSON.Formatter implements the ability to format JSON documents which are expressed as strings, text or dynamic objects. More...
 
_.Library.Status FormatToStream (input, _.Stream.Object export)
 Format a JSON document using the specified indentation and write it to a stream. More...
 
_.Library.Status FormatToString (input, _.Library.String export)
 Format a JSON document using the specified indentation and write it to a string. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 Indent
 Indent specifies that indentation of the JSON output should take place. More...
 
 IndentChars
 IndentChars specifies the character sequence to be used for each indent level if Indent=1. More...
 
 LineTerminator
 LineTerminator specifies the character sequence to terminate each line when indenting. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

JSON.Formatter implements the ability to format JSON documents which are expressed as strings, text or dynamic objects.

Member Function Documentation

◆ Format()

_.Library.Status Format (   input)

JSON.Formatter implements the ability to format JSON documents which are expressed as strings, text or dynamic objects.

Format a JSON document using the specified indentation and write it to the current device.

The input argument is either JSON as a string or stream, or a subclass of DynamicAbstractObject.

◆ FormatToStream()

_.Library.Status FormatToStream (   input,
_.Stream.Object  export 
)

Format a JSON document using the specified indentation and write it to a stream.


The input argument is either JSON as a string or stream, or a subclass of DynamicAbstractObject.

◆ FormatToString()

_.Library.Status FormatToString (   input,
_.Library.String  export 
)

Format a JSON document using the specified indentation and write it to a string.


Serialize a JSON enabled class as a JSON document and return it as a string.

Member Data Documentation

◆ Indent

Indent

Indent specifies that indentation of the JSON output should take place.

 

◆ IndentChars

IndentChars

IndentChars specifies the character sequence to be used for each indent level if Indent=1.

 

◆ LineTerminator

LineTerminator

LineTerminator specifies the character sequence to terminate each line when indenting.