Page History

Div

Excerpt

Syntax

Code Block

language	none

set aString = anObject.classToJSON()
set aString = anObject.classToJSON(options)

Semantics

The operation classToJSON() takes any object (anObject) or array of objects and tries to map it to a JSON string aString. If this is not possible, an error is raised.
JSON types and xUML types are mapped as listed on JSON Type Mapping.

Info
`classToJSON()` does not support cyclic structures. When a cyclic structure is detected during serializing the given object, an exception will be thrown.

Substitutables anObject Any object.

aString Target JSON document as String.

options

The optional parameter is an object of type ComposerOptions.

Image Removed

Image Added

Its attribute is:

Attribute	Type	Description	Allowed Values

compact

keepNulls

Boolean

When compact

When keepNulls is true, attributes of anObject with NULL values will be rendered to the JSON

composer will generate compact JSON

object, otherwise

it will generate pretty JSON

they will be left out completely (see also chapter NULL Values). The default behavior of classToJson() (i.e. when called without options) is equivalent to

compact

keepNulls=false.

true

Generate compact JSON

Render NULL attributes to the JSON object.

false

Generate pretty JSON

Leave out NULL attributes (default).

keepNulls

compact

Boolean

When keepNulls

When compact is true,

attributes of anObject with NULL values will be rendered to the JSON object, otherwise they will be left out completely (see also chapter NULL Values)

the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. The default behavior of classToJson() (i.e. when called without options) is equivalent to

keepNulls

compact=false.

true

Render NULL attributes to the JSON object

Generate compact JSON.

false

Leave out NULL attributes

Generate pretty JSON (default).

writeTypeDiscriminator

Boolean

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	writeTypeDiscriminator
PageWithExcerpt	INTERNAL:_designer_excerpts_asl
shouldDisplayInlineCommentsInIncludes	false

This is necessary if you want to convert the generated JSON back to an xUML class using jsonToClass().

Runtime versions before 2021.6 will ignore the value.

true

Write xUML type discriminator (default).

false

Do not write xUML type discriminator.

Examples

Code Block

language	none

set addressAsJSONDocument = myAddress.classToJSON();

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	JSONAdapter_Example
PageWithExcerpt	INTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludes	false

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	JSONAdapter_Example
PageWithExcerpt	INTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludes	false

rp

Panel

title	Related Pages:

Page tree

Versions Compared

Old Version 2

New Version Current

Key