Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WDESIGNER and version 22.2a
Div
Excerpt
Syntax
Code Block
languagenone
set aString = anObject.classToJSON()
set aString = anObject.classToJSON(options)
Semantics

The operation classToJSON() takes any object (anObject) 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.

SubstitutablesanObjectAny object. 
aStringTarget JSON document as String.
options

The optional parameter is an object of type ComposerOptions.

Image Removed

Image Added

Its attribute is:

AttributeTypeDescriptionAllowed Values
compactBooleanWhen compact is true, 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 compact=false.trueGenerate compact JSON.
falseGenerate pretty JSON (default).
keepNullsBooleanWhen keepNulls 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 default behavior of classToJson() (i.e. when called without options) is equivalent to keepNulls=false.trueRender NULL attributes to the JSON object.
falseLeave out NULL attributes (default).
writeTypeDiscriminatorBoolean

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamewriteTypeDiscriminator
PageWithExcerptINTERNAL:_designer_excerpts_asl
shouldDisplayInlineCommentsInIncludesfalse
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.

trueWrite xUML type discriminator (default).
falseDo not write xUML type discriminator.
Examples
Code Block
languagenone
set addressAsJSONDocument = myAddress.classToJSON();

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameJSONAdapter_Example
PageWithExcerptINTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludesfalse

Div
Stylemargin-top: -21px

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameJSONAdapter_Example
PageWithExcerptINTERNAL:_designer_examples
shouldDisplayInlineCommentsInIncludesfalse

Rp