1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions Copyrighted [year] [name of copyright owner]".
13 *
14 * Copyright 2015-2016 ForgeRock AS.
15 */
16
17 package org.forgerock.json;
18
19 /**
20 * RFC6902 expects the patch value to be a predetermined, static value to be used in the
21 * patch operation's execution. This class provides a means to extend that behavior to
22 * allow for values that require transformation based on the patch target document.
23 *
24 * This impl is the default used by {@link JsonPatch} but may be overridden by calling
25 * JsonPatch.patch(JsonValue original, JsonValue patch, JsonPatchValueTransform custom).
26 */
27 public interface JsonPatchValueTransformer {
28 /**
29 * Return the value to be used for a given patch operation.
30 *
31 * @param target the patch target document. Target is unused by default, made available
32 * for use by custom transforms.
33 * @param op the patch operation.
34 * @return The value from target pointed to by op, transformed as required by the implementation.
35 * @throws JsonValueException when the value cannot be located in the target.
36 */
37 Object getTransformedValue(JsonValue target, JsonValue op);
38 }
39