/ORK/IF_JSON_NODE_OBJECT

Reference

/ORK/JSON_NODE

Interface

/ORK/IF_JSON_NODE_OBJECT

JSON Object

Package: /ORK/JSON_NODE
Interfaces: /ORK/IF_JSON_NODE, /ORK/IF_JSON_NODE_ENUMERABLE
Members: 15

Description

Represents a JSON object node (name/value map). Provides member access by name, supports enumeration, cloning, formatting/serialization, equality, and freezing via the base node interface.

Immutability contract: Any modifying operation must raise an exception if the node is frozen.

15 items

Methods

get

Method

Public

Get member node

Returns the node for the given member name. If the member does not exist, the optional fallback is returned (if provided).

Parameters

Name

Description

name

Member name

fallback

Fallback node if member does not exist (optional)

result

Member node (or fallback)

Signature

METHODS get IMPORTING !name TYPE string
                        fallback TYPE REF TO /ork/if_json_node OPTIONAL
              RETURNING VALUE(result) TYPE REF TO /ork/if_json_node.

set

Method

Public

Set member node

Adds or replaces the node for the given member name. Must raise an exception if the node is frozen.

Parameters

Name

Description

name

Member name

node

Node to set

self

This object instance (fluent API)

Signature

METHODS set IMPORTING !name TYPE string
                        !node TYPE REF TO /ork/if_json_node
              RETURNING VALUE(self) TYPE REF TO /ork/if_json_node_object.

remove

Method

Public

Remove member

Removes the member with the given name. Must raise an exception if the node is frozen.

Parameters

Name

Description

name

Member name

result

abap_true if a member was removed, otherwise abap_false

Signature

METHODS remove IMPORTING !name TYPE string
                 RETURNING VALUE(result) TYPE abap_bool.

has

Method

Public

Check member existence

Parameters

Name

Description

name

Member name

result

abap_true if the member exists, otherwise abap_false

Signature

METHODS has IMPORTING !name TYPE string
              RETURNING VALUE(result) TYPE abap_bool.

members

Method

Public

Get members table

Returns the internal table of object members.

Parameters

Name

Description

result

Table of object members (name/node pairs)

Signature

METHODS members RETURNING VALUE(result) TYPE /ork/if_json_node=>ty-members.

iterator

Method

Public

Create iterator

Returns a new iterator instance positioned before the first member.

Parameters

Name

Description

result

New iterator instance

Signature

METHODS iterator RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_iterator.

get_array

Method

Public

Get array member node

Returns the array node for the given member name. If the member does not exist or is not an array, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback array node (optional)

result

Array member node (or fallback)

Signature

METHODS get_array IMPORTING !name TYPE string
                              fallback TYPE REF TO /ork/if_json_node_array DEFAULT /ork/cl_json=>fallback-array
                    RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_array.

get_object

Method

Public

Get object member node

Returns the object node for the given member name. If the member does not exist or is not an object, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback object node (optional)

result

Object member node (or fallback)

Signature

METHODS get_object IMPORTING !name TYPE string
                               fallback TYPE REF TO /ork/if_json_node_object DEFAULT /ork/cl_json=>fallback-object
                     RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_object.

get_null

Method

Public

Get null member node

Returns the null node for the given member name. If the member does not exist or is not null, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback null node (optional)

result

Null member node (or fallback)

Signature

METHODS get_null IMPORTING !name TYPE string
                             fallback TYPE REF TO /ork/if_json_node_null DEFAULT /ork/cl_json=>fallback-null
                   RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_null.

get_number

Method

Public

Get number member node

Returns the number node for the given member name. If the member does not exist or is not a number, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback number node (optional)

result

Number member node (or fallback)

Signature

METHODS get_number IMPORTING !name TYPE string
                               fallback TYPE REF TO /ork/if_json_node_number DEFAULT /ork/cl_json=>fallback-number
                     RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_number.

get_string

Method

Public

Get string member node

Returns the string node for the given member name. If the member does not exist or is not a string, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback string node (optional)

result

String member node (or fallback)

Signature

METHODS get_string IMPORTING !name TYPE string
                               fallback TYPE REF TO /ork/if_json_node_string DEFAULT /ork/cl_json=>fallback-string
                     RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_string.

get_bool

Method

Public

Get boolean member node

Returns the boolean node for the given member name. If the member does not exist or is not a boolean, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback boolean node (optional)

result

Boolean member node (or fallback)

Signature

METHODS get_bool IMPORTING !name TYPE string
                             fallback TYPE REF TO /ork/if_json_node_bool DEFAULT /ork/cl_json=>fallback-bool
                   RETURNING VALUE(result) TYPE REF TO /ork/if_json_node_bool.

get_number_value

Method

Public

Get number member value

Returns the numeric value of the number node for the given member name. If the member does not exist or is not a number, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback numeric value (optional)

result

Numeric member value (or fallback)

Signature

METHODS get_number_value IMPORTING !name TYPE string
                                     fallback TYPE numeric OPTIONAL
                           RETURNING VALUE(result) TYPE decfloat34.

get_string_value

Method

Public

Get string member value

Returns the text value of the string node for the given member name. If the member does not exist or is not a string, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback string value (optional)

result

String member value (or fallback)

Signature

METHODS get_string_value IMPORTING !name TYPE string
                                     fallback TYPE string OPTIONAL
                           RETURNING VALUE(result) TYPE string.

get_bool_value

Method

Public

Get boolean member value

Returns the boolean value of the boolean node for the given member name. If the member does not exist or is not a boolean, the optional fallback is returned.

Parameters

Name

Description

name

Member name

fallback

Fallback boolean value (optional)

result

Boolean member value (or fallback)

Signature

METHODS get_bool_value IMPORTING !name TYPE string
                                   fallback TYPE abap_bool OPTIONAL
                         RETURNING VALUE(result) TYPE abap_bool.

Repository

11 packages · 113 objects

124 items