Module jakarta.json

Package jakarta.json

Enum JsonPatch.Operation

java.lang.Object

java.lang.Enum<JsonPatch.Operation>

jakarta.json.JsonPatch.Operation

All Implemented Interfaces:

Serializable, Comparable<JsonPatch.Operation>

Enclosing interface:

JsonPatch

public static enum JsonPatch.Operation
extends Enum<JsonPatch.Operation>

This enum represents the list of valid JSON Patch operations as defined by RFC 6902.

See Also:

RFC 6902

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	"add" operation.
COPY	"copy" operation.
MOVE	"move" operation.
REMOVE	"remove" operation.
REPLACE	"replace" operation.
TEST	"test" operation.

Method Summary

Modifier and Type	Method	Description
static JsonPatch.Operation	fromOperationName(String operationName)	Returns the enum constant with the specified name.
String	operationName()	Returns enum constant name as lower case string.
static JsonPatch.Operation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JsonPatch.Operation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADD

public static final JsonPatch.Operation ADD

"add" operation.

REMOVE

public static final JsonPatch.Operation REMOVE

"remove" operation.

REPLACE

public static final JsonPatch.Operation REPLACE

"replace" operation.

MOVE

public static final JsonPatch.Operation MOVE

"move" operation.

COPY

public static final JsonPatch.Operation COPY

"copy" operation.

TEST

public static final JsonPatch.Operation TEST

"test" operation.

Method Detail

values

public static JsonPatch.Operation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JsonPatch.Operation c : JsonPatch.Operation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JsonPatch.Operation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

operationName

public String operationName()

Returns enum constant name as lower case string.

Returns:

lower case name of the enum constant

fromOperationName

public static JsonPatch.Operation fromOperationName(String operationName)

Returns the enum constant with the specified name.

Parameters:

operationName - operationName to convert to the enum constant.

Returns:

the enum constant for given operationName

Throws:

JsonException - if given operationName is not recognized