io.swagger.transform.util

Class MutableJsonTree

java.lang.Object

io.swagger.transform.util.MutableJsonTree

@ParametersAreNonnullByDefault
public final class MutableJsonTree
extends java.lang.Object

A mutable JSON tree with traversal capabilities

Navigation through the tree is done using JsonPointers.

Note that JsonNode is mutable. This means that at init time we make a copy of the node given as argument (using JsonNode.deepCopy(), but after that all nodes returned by getCurrentNode() are mutable. Changes you make to the returned node therefore will be reflected in the result.

While you can do that, it is advised that you use SwaggerMigrators instead and make use of the applyMigrator(SwaggerMigrator) and applyMigratorToElements(SwaggerMigrator) methods.

Constructor Summary

Constructors

Constructor and Description
MutableJsonTree(com.fasterxml.jackson.databind.JsonNode node) Constructor

Method Summary

Modifier and Type	Method and Description
void	appendPointer(com.github.fge.jackson.jsonpointer.JsonPointer pointer) Relative pointer change
void	applyMigrator(SwaggerMigrator migrator) Apply a migrator to the node at the current pointer
void	applyMigratorToElements(SwaggerMigrator migrator) Apply a migrator to all elements of the array at the current pointer
void	applyPatch(com.github.fge.jsonpatch.JsonPatch patch) Apply a JSON Patch to the current node
void	applyPatchToElements(com.github.fge.jsonpatch.JsonPatch patch) Apply a JSON Patch to all elements of a JSON Array
com.fasterxml.jackson.databind.JsonNode	getBaseNode() Return the base node
com.fasterxml.jackson.databind.JsonNode	getCurrentNode() Get the value at the current pointer (always guaranteed to exist)
void	setPointer(com.github.fge.jackson.jsonpointer.JsonPointer pointer) Absolute pointer change
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MutableJsonTree

public MutableJsonTree(com.fasterxml.jackson.databind.JsonNode node)

Constructor

Parameters:

node - the node to transform (copied)

Method Detail

setPointer

public void setPointer(com.github.fge.jackson.jsonpointer.JsonPointer pointer)

Absolute pointer change

The new current node will be the node at this pointer starting from the base node.

Parameters:

pointer - the pointer

Throws:

java.lang.IllegalArgumentException - no JSON value at given pointer

appendPointer

public void appendPointer(com.github.fge.jackson.jsonpointer.JsonPointer pointer)

Relative pointer change

The pointer in argument is appended to the current pointer (using JsonPointer.append(JsonPointer)) and the current node is set accordingly.

Parameters:

pointer - the pointer to append

Throws:

java.lang.IllegalArgumentException - no JSON value at given pointer

getBaseNode

public com.fasterxml.jackson.databind.JsonNode getBaseNode()

Return the base node

The "base node" here means the (potentially) altered copy of the node supplied as the constructor argument.

Returns:

the base node

getCurrentNode

public com.fasterxml.jackson.databind.JsonNode getCurrentNode()

Get the value at the current pointer (always guaranteed to exist)

Returns:

the (mutable) node

applyPatch

public void applyPatch(com.github.fge.jsonpatch.JsonPatch patch)
                throws SwaggerMigrationException

Apply a JSON Patch to the current node

This will turn the patch into a SwaggerMigrator using SwaggerMigrators.fromPatch(JsonPatch) and call applyMigrator(SwaggerMigrator).

Parameters:

patch - the JSON Patch to apply

Throws:

SwaggerMigrationException - same as applyMigrator(SwaggerMigrator)

applyMigrator

public void applyMigrator(SwaggerMigrator migrator)
                   throws SwaggerMigrationException

Apply a migrator to the node at the current pointer

It is assumed here that the current node is a JSON Object.

Parameters:

migrator - the migrator to apply

Throws:

SwaggerMigrationException - current node is not an object, or the migrator failed to apply

applyMigratorToElements

public void applyMigratorToElements(SwaggerMigrator migrator)
                             throws SwaggerMigrationException

Apply a migrator to all elements of the array at the current pointer

Note that if the migrator fails to apply to at least one element, the original array is left untouched; its elements are replaced if and only if the migrator applies successfully to all elements.

Parameters:

migrator - the migrator to apply

Throws:

SwaggerMigrationException - current node is not a JSON Array, or migrator failed to apply to at least one array element

applyPatchToElements

public void applyPatchToElements(com.github.fge.jsonpatch.JsonPatch patch)
                          throws SwaggerMigrationException

Apply a JSON Patch to all elements of a JSON Array

This will wrap the patch into a SwaggerMigrator using SwaggerMigrators.fromPatch(JsonPatch) and call applyMigratorToElements(SwaggerMigrator).

Parameters:

patch - the JSON Patch to apply

Throws:

SwaggerMigrationException - same as applyMigratorToElements(SwaggerMigrator)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object