com.github.fge.jsonpatch.operation

Class OmitArrayOptionalOperation

java.lang.Object

com.github.fge.jsonpatch.operation.PathValueOperation

com.github.fge.jsonpatch.operation.OmitArrayOptionalOperation

All Implemented Interfaces:

JsonSerializable, JsonPatchOperation

public final class OmitArrayOptionalOperation
extends PathValueOperation

Extended JSON Patch omitArray? operation. The operation will remove all the items equivalent to value from the array at path. The operation will remove the parent node if applying the operation to the array results in an empty array. The operation will throw an exception if the node at path is not an array. The operation will do nothing if no items in the array at path are equivalent to value.

Field Summary

Fields

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

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

BUNDLE, op, path, value

Constructor Summary

Constructors

Constructor and Description
OmitArrayOptionalOperation(JsonPointer path, JsonNode value)

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

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

OmitArrayOptionalOperation

public OmitArrayOptionalOperation(JsonPointer path,
                                  JsonNode value)

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