Breadcrumbs

jsonToClass() Operation

Syntax

set anObject = aString.jsonToClass()
set anObject = jsonToClass(literal)

Semantics

Takes an JSON string (aString) and tries to map it to anObject. If this is not possible, an error is raised.

By default, the following mapping rules apply:

  • JSON attributes are mapped to class attributes having the same name.

  • Attributes not defined in the target class are ignored.

For more mapping details refer to JSON Type Mapping.

Substitutables

aString

A JSON document as String.

anObject

Target object, can be any object.

literal

String literal.

Examples

set myAddress = addressAsJSONDocument.jsonToClass();

The action script below creates an object of type Address. An output object flow state named myAddress of type Address needs to be defined in the activity diagram.

create myAddress;
set myAddress = addressAsJSONDocument.jsonToClass();

The example below shows how to specify the xUML type at runtime, e.g. if using a derived class.

JSON
{
  "e2e:type":"urn:json.e2e.ch.AddressWithEmail",
  "name":"John Snow",
  "company":"Winter & Partners",
  "mailaddress":"john.snow@winter.com"
} 
class_addresswithmail.png

The xUML type is declared by the attribute "e2e:type". The type has to be specified like <xml_namespace>.<classname>.

For more information on JSON refer to the JSON Homepage or to RFC 4627.

📗
📘

Related Documentation: