com.github.fge.jsonpatch.operation

Class MoveOperation

java.lang.Object

com.github.fge.jsonpatch.operation.DualPathOperation

com.github.fge.jsonpatch.operation.MoveOperation

All Implemented Interfaces:

JsonSerializable, JsonPatchOperation

public final class MoveOperation
extends DualPathOperation

JSON Patch move operation

For this operation, from points to the value to move, and path points to the new location of the moved value.

As for add:

• the value at the destination path is either created or replaced;
• it is created only if the immediate parent exists;
• - appends at the end of an array.

It is an error condition if from does not point to a JSON value.

The specification adds another rule that the from path must not be an immediate parent of path. Unfortunately, that doesn't really work. Consider this patch:

     { "op": "move", "from": "/0", "path": "/0/x" }
 

Even though /0 is an immediate parent of /0/x, when this patch is applied to:

     [ "victim", {} ]
 

it actually succeeds and results in the patched value:

     [ { "x": "victim" } ]
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME

Fields inherited from class com.github.fge.jsonpatch.operation.DualPathOperation

BUNDLE, from, op, path

Constructor Summary

Constructors

Constructor and Description
MoveOperation(JsonPointer from, JsonPointer path)

Method Summary

Methods

Modifier and Type	Method and Description
JsonNode	apply(JsonNode node) Apply this operation to a JSON value

Methods inherited from class com.github.fge.jsonpatch.operation.DualPathOperation

serialize, serializeWithType, toString

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

MoveOperation

public MoveOperation(JsonPointer from,
             JsonPointer path)

Method Detail

apply

public JsonNode apply(JsonNode node)
               throws JsonPatchException

Description copied from interface: JsonPatchOperation

Apply this operation to a JSON value

Parameters:

node - the value to patch

Returns:

the patched value

Throws:

JsonPatchException - operation failed to apply to this value