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 com.fasterxml.jackson.annotation.JsonCreator;
38  import com.fasterxml.jackson.annotation.JsonProperty;
39  import com.fasterxml.jackson.core.JsonPointer;
40  import com.fasterxml.jackson.databind.JsonNode;
41  
42  /**
43   * JSON Patch {@code test} operation.
44   *
45   * <p>The two arguments for this operation are the pointer containing the value
46   * to test ({@code path}) and the value to test equality against ({@code
47   * value}).</p>
48   *
49   * <p>It is an error if no value exists at the given path.</p>
50   *
51   * <p>Also note that equality as defined by JSON Patch is exactly the same as it
52   * is defined by JSON Schema itself. As such, this operation reuses {@link
53   * JsonNumEquals} for testing equality.</p>
54   */
55  public final class TestOperation extends PathValueOperation {
56  
57      @JsonCreator
58      public TestOperation(@JsonProperty("path") final JsonPointer path,
59                           @JsonProperty("value") final JsonNode value) {
60          super("test", path, value);
61      }
62  
63      @Override
64      JsonNode apply(final JsonNode node) {
65          ensureEquivalence(ensureExistence(node));
66          return node;
67      }
68  }