JsonPatch operations as enum

[glassfishrobot]

the operations are limited 6 operations. it would make it clearer for users if we add them as en enum.

documentation would also be much easier and clearer.

**JsonPatchOperation.java**public enum JsonPatchOperation {

    /**
     * documentation goes here
     */
    ADD,

    REMOVE,
    ...
}

Affected Versions

[1.1]

[glassfishrobot]

Reported by rsandtner

[glassfishrobot]

rsandtner said: operations are defined in RFC-6902

[glassfishrobot]

struberg said: The question is whether a user has to deal with them from 'external' or only inside the impl.

Pro 'external': if you create a JsonPatch from a JsonArray then it might be useful to have them Con: why should someone manually create a JsonPatch via a JsonArray if he could also use a JsonPatchBuilder? Building a JsonPatch from an array is mostly if you get the JSON via a REST endpoint etc, isn't?

[glassfishrobot]

@lukasj said: My current thinking is to have:

public interface JsonPatch {
   enum Operation {ADD, REMOVE,...}
....
}

it has some benefits for providers, so they won't be required to deal with string constants in their implementations and in 'external' case I can imagine ie following use-case:

• patch comes from external source as JsonArray
• say one wants to change all move() to test() operations for some reason, ie he does not believe that the patch will be applied properly, so he reads "op" property and if it is 'move' then replace it with 'test' => I think it would preferred to do operation name comparison against some defined constant over doing string comparison

maybe not a real world example but I think you get the point

[glassfishrobot]

@lukasj said: full patch showing my thinking. Feel free to comment. Thanks!

[glassfishrobot]

rsandtner said: looks good for me

just one point from my side:

instead of switch (name.toLowerCase()) ... you can use

for (Operation op : values()) {
    if (op.getOperationName().equals(name)) {
        return op;
    }
}

throw new IllegalArgumentException("unknown operation);

thanks for pushing it forward

[glassfishrobot]

@lukasj said: thanks! went with your suggestion except for the exception type being thrown, details at: https://java.net/projects/jsonp/sources/git/revision/7731c1e

[glassfishrobot]

File: 0001-JSON_PROCESSING_SPEC-79-JsonPatch-operations-as-enum.patch Attached By: @lukasj

[glassfishrobot]

This issue was imported from java.net JIRA JSON_PROCESSING_SPEC-79

[glassfishrobot]

Marked as fixed on Wednesday, December 7th 2016, 3:30:23 am