com.github.fge.jsonpatch.operation

Class TranslateArrayOptionalOperation

java.lang.Object

com.github.fge.jsonpatch.operation.PathDualValueOperation

com.github.fge.jsonpatch.operation.TranslateArrayOptionalOperation

All Implemented Interfaces:

JsonSerializable, JsonPatchOperation

public final class TranslateArrayOptionalOperation
extends PathDualValueOperation

Extended JSON Patch translateArray? operation. The operation will translate all items equivalent to fromValue to a toValue in the array at path if they exist. The operation will do nothing if no items in the array at path are equivalent to fromValue. The operation will throw an exception if the node at path is not an array.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME

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

BUNDLE, fromValue, op, path, toValue

Constructor Summary

Constructors

Constructor and Description
TranslateArrayOptionalOperation(JsonPointer path, JsonNode fromValue, JsonNode toValue)

Method Summary

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.PathDualValueOperation

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 java.lang.String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

TranslateArrayOptionalOperation

public TranslateArrayOptionalOperation(JsonPointer path,
                                       JsonNode fromValue,
                                       JsonNode toValue)

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