An immutable map describing the changes to a JSON value. More...

#include <PTDiffusionJSONDeltaChangeMap.h>

Inheritance diagram for PTDiffusionJSONDeltaChangeMap:

Instance Methods
(nullable PTDiffusionJSONDeltaChangeMap *)	- descendantsOfPointer:error:
(nullable PTDiffusionJSONDeltaChangeMap *)	- intersectionOfPointer:error:

Properties
NSDictionary< NSString , PTDiffusionJSON > *	map

Detailed Description

An immutable map describing the changes to a JSON value.

The map contains an entry for each change, as follows:

The key is a JSON Pointer syntax reference locating the change in the complete value. Since a JSON value is a list of zero or more data items, the reference always begins with an array index. For example, the first part is identified by the JSON Pointer /0.
The value is part of the complete value. It is returned as a JSON object that can be parsed independently as a unit, or converted to a Foundation object or JSON string.

Since: 6.3

Method Documentation

◆ descendantsOfPointer:error:

- (nullable PTDiffusionJSONDeltaChangeMap *) descendantsOfPointer:		(NSString *)	pointer
error:		(NSError **)	error

Returns a view of the portion of this map whose keys are descendants of pointer. If pointer is contained in this map, it will be included in the result.

Parameters

pointer	JSON pointer
error	Location to store a reason in case of failure. May be nil.

Returns: JSON delta change map containing the descendants of given pointer.

Exceptions

NSInvalidArgumentException If `pointer` is `nil`.

Since: 6.3

◆ intersectionOfPointer:error:

- (nullable PTDiffusionJSONDeltaChangeMap *) intersectionOfPointer:		(NSString *)	pointer
error:		(NSError **)	error

Returns a view of the portion of this map whose keys are descendants or parents of pointer. If pointer is contained in this map, it will be included in the result.

This method can be used to determine whether a structural delta affects a particular part of a JSON value.

Parameters

pointer	JSON pointer
error	Location to store a reason in case of failure. May be nil.

Returns: JSON delta change map containing the intersection of given pointer.

Exceptions

NSInvalidArgumentException If `pointer` is `nil`.

Since: 6.3

Property Documentation

◆ map

- (NSDictionary<NSString *, PTDiffusionJSON *>*) map

readnonatomicassign

The entries forming the change map.