/ORK/IF_JSON_NODE_ARRAY

Reference

/ORK/JSON_NODE

Interface

/ORK/IF_JSON_NODE_ARRAY

JSON Array

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

Description

Represents a JSON array node and provides indexed access and mutation. Supports enumeration, cloning, formatting/serialization, equality, and freezing via the base node interface.

Index handling follows ABAP internal table semantics (one-based).

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

18 items

Methods

get

Method

Public

Get node by index

Returns the node at the given one-based index. If the index is out of range, the optional fallback is returned (if provided).

Parameters

Name

Description

index

One-based node index

fallback

Fallback node if index is out of range (optional)

result

Node at index (or fallback)

Signature

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

set

Method

Public

Set node at index

Replaces the node at the given one-based index. Must raise an exception if the node is frozen.

Parameters

Name

Description

index

One-based node index

node

Node to set

self

This array instance (fluent API)

Signature

METHODS set IMPORTING !index TYPE i
                        !node TYPE REF TO /ork/if_json_node
              RETURNING VALUE(self) TYPE REF TO /ork/if_json_node_array.

insert

Method

Public

Insert node at index

Inserts the provided node at the given one-based index and shifts subsequent nodes. Must raise an exception if the node is frozen.

Parameters

Name

Description

index

One-based insertion index

node

Node to insert

self

This array instance (fluent API)

Signature

METHODS insert IMPORTING !index TYPE i
                           !node TYPE REF TO /ork/if_json_node
                 RETURNING VALUE(self) TYPE REF TO /ork/if_json_node_array.

add

Method

Public

Append node

Appends the provided node to the end of the array. Must raise an exception if the node is frozen.

Parameters

Name

Description

node

Node to append

self

This array instance (fluent API)

Signature

METHODS add IMPORTING !node TYPE REF TO /ork/if_json_node
              RETURNING VALUE(self) TYPE REF TO /ork/if_json_node_array.

remove

Method

Public

Remove node by index

Removes the node at the given one-based index. Must raise an exception if the node is frozen.

Parameters

Name

Description

index

One-based node index

result

abap_true if a node was removed, otherwise abap_false

Signature

METHODS remove IMPORTING !index TYPE i
                 RETURNING VALUE(result) TYPE abap_bool.

clear

Method

Public

Clear array

Removes all nodes from the array. Must raise an exception if the node is frozen.

Signature

METHODS clear.

count

Method

Public

Get node count

Parameters

Name

Description

result

Number of nodes in the array

Signature

METHODS count RETURNING VALUE(result) TYPE i.

nodes

Method

Public

Get nodes table

Returns the internal table of nodes representing the array content. The returned table reflects the current order of the nodes.

Parameters

Name

Description

result

Table of array nodes

Signature

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

iterator

Method

Public

Create iterator

Returns a new iterator instance positioned before the first node.

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 node by index

Returns the array node at the given one-based index. If the index is out of range or the node is not an array, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback array node (optional)

result

Array node at index (or fallback)

Signature

METHODS get_array IMPORTING !index TYPE i
                              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 node by index

Returns the object node at the given one-based index. If the index is out of range or the node is not an object, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback object node (optional)

result

Object node at index (or fallback)

Signature

METHODS get_object IMPORTING !index TYPE i
                               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 node by index

Returns the null node at the given one-based index. If the index is out of range or the node is not null, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback null node (optional)

result

Null node at index (or fallback)

Signature

METHODS get_null IMPORTING !index TYPE i
                             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 node by index

Returns the number node at the given one-based index. If the index is out of range or the node is not a number, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback number node (optional)

result

Number node at index (or fallback)

Signature

METHODS get_number IMPORTING !index TYPE i
                               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 node by index

Returns the string node at the given one-based index. If the index is out of range or the node is not a string, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback string node (optional)

result

String node at index (or fallback)

Signature

METHODS get_string IMPORTING !index TYPE i
                               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 node by index

Returns the boolean node at the given one-based index. If the index is out of range or the node is not a boolean, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback boolean node (optional)

result

Boolean node at index (or fallback)

Signature

METHODS get_bool IMPORTING !index TYPE i
                             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 value by index

Returns the numeric value of the number node at the given one-based index. If the index is out of range or the node is not a number, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback numeric value (optional)

result

Numeric value at index (or fallback)

Signature

METHODS get_number_value IMPORTING !index TYPE i
                                     fallback TYPE numeric OPTIONAL
                           RETURNING VALUE(result) TYPE decfloat34.

get_string_value

Method

Public

Get string value by index

Returns the text value of the string node at the given one-based index. If the index is out of range or the node is not a string, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback string value (optional)

result

String value at index (or fallback)

Signature

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

get_bool_value

Method

Public

Get boolean value by index

Returns the boolean value of the boolean node at the given one-based index. If the index is out of range or the node is not a boolean, the optional fallback is returned.

Parameters

Name

Description

index

One-based node index

fallback

Fallback boolean value (optional)

result

Boolean value at index (or fallback)

Signature

METHODS get_bool_value IMPORTING !index TYPE i
                                   fallback TYPE abap_bool OPTIONAL
                         RETURNING VALUE(result) TYPE abap_bool.

Repository

11 packages · 113 objects

124 items