001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyrighted [year] [name of copyright owner]".
013 *
014 * Copyright 2015-2016 ForgeRock AS.
015 */
016
017package org.forgerock.json;
018
019/**
020 * RFC6902 expects the patch value to be a predetermined, static value to be used in the
021 * patch operation's execution.  This class provides a means to extend that behavior to
022 * allow for values that require transformation based on the patch target document.
023 *
024 * This impl is the default used by {@link JsonPatch} but may be overridden by calling
025 * JsonPatch.patch(JsonValue original, JsonValue patch, JsonPatchValueTransform custom).
026 */
027public interface JsonPatchValueTransformer {
028    /**
029     * Return the value to be used for a given patch operation.
030     *
031     * @param target the patch target document.  Target is unused by default, made available
032     *               for use by custom transforms.
033     * @param op the patch operation.
034     * @return The value from target pointed to by op, transformed as required by the implementation.
035     * @throws JsonValueException when the value cannot be located in the target.
036     */
037    Object getTransformedValue(JsonValue target, JsonValue op);
038}
039