1   /*
2    * Copyright 2017 LINE Corporation
3    *
4    * LINE Corporation licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  /*
17   * Copyright (c) 2014, Francis Galiegue (fgaliegue@gmail.com)
18   *
19   * This software is dual-licensed under:
20   *
21   * - the Lesser General Public License (LGPL) version 3.0 or, at your option, any
22   *   later version;
23   * - the Apache Software License (ASL) version 2.0.
24   *
25   * The text of this file and of both licenses is available at the root of this
26   * project or, if you have the jar distribution, in directory META-INF/, under
27   * the names LGPL-3.0.txt and ASL-2.0.txt respectively.
28   *
29   * Direct link to the sources:
30   *
31   * - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
32   * - ASL 2.0: https://www.apache.org/licenses/LICENSE-2.0.txt
33   */
34  
35  package com.linecorp.centraldogma.internal.jsonpatch;
36  
37  import java.io.IOException;
38  
39  import com.fasterxml.jackson.annotation.JsonCreator;
40  import com.fasterxml.jackson.annotation.JsonProperty;
41  import com.fasterxml.jackson.core.JsonGenerator;
42  import com.fasterxml.jackson.core.JsonPointer;
43  import com.fasterxml.jackson.databind.JsonNode;
44  import com.fasterxml.jackson.databind.SerializerProvider;
45  import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
46  import com.fasterxml.jackson.databind.node.ArrayNode;
47  import com.fasterxml.jackson.databind.node.MissingNode;
48  import com.fasterxml.jackson.databind.node.ObjectNode;
49  
50  /**
51   * JSON Path {@code remove} operation.
52   *
53   * <p>This operation only takes one pointer ({@code path}) as an argument. It
54   * is an error condition if no JSON value exists at that pointer.</p>
55   */
56  public final class RemoveOperation extends JsonPatchOperation {
57  
58      @JsonCreator
59      public RemoveOperation(@JsonProperty("path") final JsonPointer path) {
60          super("remove", path);
61      }
62  
63      @Override
64      JsonNode apply(final JsonNode node) {
65          if (path.toString().isEmpty()) {
66              return MissingNode.getInstance();
67          }
68          ensureExistence(node);
69  
70          final JsonNode parentNode = node.at(path.head());
71          final String raw = path.last().getMatchingProperty();
72          if (parentNode.isObject()) {
73              ((ObjectNode) parentNode).remove(raw);
74          } else {
75              ((ArrayNode) parentNode).remove(Integer.parseInt(raw));
76          }
77          return node;
78      }
79  
80      @Override
81      public void serialize(final JsonGenerator jgen,
82                            final SerializerProvider provider) throws IOException {
83          jgen.writeStartObject();
84          jgen.writeStringField("op", "remove");
85          jgen.writeStringField("path", path.toString());
86          jgen.writeEndObject();
87      }
88  
89      @Override
90      public void serializeWithType(final JsonGenerator jgen,
91                                    final SerializerProvider provider, final TypeSerializer typeSer)
92              throws IOException {
93          serialize(jgen, provider);
94      }
95  
96      @Override
97      public String toString() {
98          return "op: " + op + "; path: \"" + path + '"';
99      }
100 }