Package io.jmix.core

Interface FetchPlanSerialization

All Known Implementing Classes:
FetchPlanSerializationImpl
public interface FetchPlanSerialization
Class that is used for serialization and deserialization of fetch plan to JSON.

  • Method Details

    • fromJson

      FetchPlan fromJson(String json)
      Deserializes a JSON object to fetch plan. The method automatically identifies whether the fetch plan was serialized with the FetchPlanSerializationOption.COMPACT_FORMAT option.
      Parameters:
      json - JSON objects that represents the fetch plan
      Returns:
      a fetchPlan

    • toJson

      String toJson(FetchPlan fetchPlan, FetchPlanSerializationOption... options)
      Serializes a fetch plan to JSON object
      Parameters:
      fetchPlan - a fetchPlan
      options - options specifying how a JSON object graph should be serialized
      Returns:
      a string that represents a JSON object

    • toJson

      String toJson(FetchPlan fetchPlan, Function<MetaClass,String> entityNameExtractor, FetchPlanSerializationOption... options)
      Serializes a fetch plan to JSON string.
      Parameters:
      fetchPlan - a fetchPlan
      entityNameExtractor - a function that returns an entity name by MetaClass
      options - options specifying how a JSON object graph should be serialized
      Returns:
      a string that represents a JSON object