ContextualReplaceOperation.java

/*
 * Copyright 2014 Tariq Bugrara
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.progix.dropwizard.patch.operations.contextual;

import io.progix.dropwizard.patch.JsonPatchValue;
import io.progix.dropwizard.patch.JsonPath;
import io.progix.dropwizard.patch.operations.ReplaceOperation;

/**
 * @param <T> the type of the object this replace operation should be preformed on
 * @see ReplaceOperation
 */
public interface ContextualReplaceOperation<T> {

    /**
     * @param context The context this replace operation should be preformed on
     * @param path    The {@link JsonPath} for the location of what value to be replaced.
     * @param value   The {@link JsonPatchValue} that replaces the location specified by the path parameter
     * @see ReplaceOperation
     */
    public T replace(T context, JsonPath path, JsonPatchValue value);

}