com.ibm.fhir.model.patch.FHIRPatch Maven / Gradle / Ivy

/*
 * (C) Copyright IBM Corp. 2019, 2021
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package com.ibm.fhir.model.patch;

import jakarta.json.JsonArray;
import jakarta.json.JsonPatch;

import com.ibm.fhir.model.patch.exception.FHIRPatchException;
import com.ibm.fhir.model.resource.Resource;

public interface FHIRPatch {
    /**
     * Apply this patch to a resource
     * 
     * @param resource
     *     the resource that this patch is applied to
     * @return
     *     a new resource that is the result of applying this patch
     */
     T apply(T resource) throws FHIRPatchException;
    
    default  T as(Class patchClass) {
        return patchClass.cast(this);
    }
    
    /**
     * Factory method that constructs a new FHIRPatch object 
     * from a JsonArray object
     * 
     * @param array
     *     the JsonArray object
     * @return
     *     the newly constructed FHIRPatch object
     */
    static FHIRPatch patch(JsonArray array) {
        return new FHIRJsonPatch(array);
    }
    
    /**
     * Factory method that constructs a new FHIRPatch object 
     * from a JsonPatch object
     * 
     * @param patch
     *     the JsonPatch object
     * @return
     *     the newly constructed FHIRPatch object
     */
    static FHIRPatch patch(JsonPatch patch) {
        return new FHIRJsonPatch(patch);
    }
}