Package org.springframework.data.rest.webmvc.json.patch

Interface PatchConverter<T>

Type Parameters:
T - A type holding a representation of the patch. For example, a JsonNode if working with JSON Patch.
All Known Implementing Classes:
JsonPatchPatchConverter
public interface PatchConverter<T>

A strategy interface for producing Patch instances from a patch document representation (such as JSON Patch) and rendering a Patch to a patch document representation. This decouples the Patch class from any specific patch format or library that holds the representation.

For example, if the Patch is to be represented as JSON Patch, the representation type could be JsonNode or some other JSON library's type that holds a JSON document.

Author:
Craig Walls, Oliver Gierke

  • Method Summary

    Modifier and Type
    Method
    Description
    Patch
    convert(T patchRepresentation)
    Convert a patch document representation to a Patch.

  • Method Details

    • convert

      Patch convert(T patchRepresentation)
      Convert a patch document representation to a Patch.
      Parameters:
      patchRepresentation - the representation of a patch.
      Returns:
      the Patch object that the document represents.