ca.gc.aafc.dina.jsonapi.JsonPathHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dina-base-api Show documentation

Base DINA API package for Java built on SpringBoot and Crnk

There is a newer version: 0.132

package ca.gc.aafc.dina.jsonapi;

import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.PathNotFoundException;
import com.jayway.jsonpath.TypeRef;

/**
 * Utility methods to use jsonPath on documents.
 */
public final class JsonPathHelper {

  private static final String MATCH_ID_JSON_PATH = "$.*[?(@.id == '%s')]";

  // Utility class
  private JsonPathHelper() {
  }

  /**
   * Extracts part of the document by id using JsonPath. Mostly useful to extract a part of document from an array.
   * @param dc documentContext created over the target document
   * @param id the value of id to search on
   * @param typeRef the jsonpath TypeRef
   * @return
   */
  public static  T extractById(DocumentContext dc, String id, TypeRef typeRef) {
    try {
      return dc.read(String.format(MATCH_ID_JSON_PATH, id), typeRef);
    } catch (PathNotFoundException pnf) {
      return null;
    }
  }

}