com.github.fge.jsonpatch.operation

Class RemoveOperation

java.lang.Object

com.github.fge.jsonpatch.operation.RemoveOperation

All Implemented Interfaces:

JsonSerializable, JsonPatchOperation

public final class RemoveOperation
extends Object
implements JsonPatchOperation

JSON Path remove operation

This operation only takes one pointer (path) as an argument. It is an error condition if no JSON value exists at that pointer.

Field Summary

Fields

Modifier and Type	Field and Description
protected static MessageBundle	BUNDLE
protected String	op
static String	OPERATION_NAME
protected JsonPointer	path

Constructor Summary

Constructors

Constructor and Description
RemoveOperation(JsonPointer path)

Method Summary

Methods

Modifier and Type	Method and Description
JsonNode	apply(JsonNode node) Apply this operation to a JSON value
void	serialize(JsonGenerator jgen, SerializerProvider provider)
void	serializeWithType(JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer)
String	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

BUNDLE

protected static final MessageBundle BUNDLE

op

protected final String op

path

protected final JsonPointer path

Constructor Detail

RemoveOperation

public RemoveOperation(JsonPointer path)

Method Detail

apply

public JsonNode apply(JsonNode node)
               throws JsonPatchException

Description copied from interface: JsonPatchOperation

Apply this operation to a JSON value

Specified by:

apply in interface JsonPatchOperation

Parameters:

node - the value to patch

Returns:

the patched value

Throws:

JsonPatchException - operation failed to apply to this value

serialize

public void serialize(JsonGenerator jgen,
             SerializerProvider provider)
               throws IOException,
                      JsonProcessingException

Specified by:

serialize in interface JsonSerializable

Throws:

IOException

JsonProcessingException

serializeWithType

public void serializeWithType(JsonGenerator jgen,
                     SerializerProvider provider,
                     TypeSerializer typeSer)
                       throws IOException,
                              JsonProcessingException

Specified by:

serializeWithType in interface JsonSerializable

Throws:

IOException

JsonProcessingException

toString

public String toString()

Specified by:

toString in interface JsonPatchOperation

Overrides:

toString in class Object