io.jmix.core

Enum FetchPlanSerializationOption

java.lang.Object

java.lang.Enum<FetchPlanSerializationOption>

io.jmix.core.FetchPlanSerializationOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FetchPlanSerializationOption>

public enum FetchPlanSerializationOption
extends java.lang.Enum<FetchPlanSerializationOption>

An object that configures how to serialize a fetch plan to JSON. Objects of this type are used by methods of the FetchPlanSerialization. This object may be also used during the deserialization.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT_FORMAT Specifies that fetch plan is serialized in the compact format.
INCLUDE_FETCH_MODE Specifies that an information about properties fetch mode will be included to the JSON.

Method Summary

Modifier and Type	Method and Description
static FetchPlanSerializationOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FetchPlanSerializationOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMPACT_FORMAT

public static final FetchPlanSerializationOption COMPACT_FORMAT

Specifies that fetch plan is serialized in the compact format. In compact format repeated nested fetch plans are replaced with just a fetch plan name. For example fetch plan for customerGroup2 is defined with a string:

 {
  "name": "customer-fp",
  "entity": "sample_Customer",
  "properties": [
      "name",
      {
          "name": "customerGroup",
          "fetchPlan": {
              "name": "customerGroup-fp",
              "properties": [
                  "id",
                  "createdBy",
                  "createTs",
                  "name"
              ]
          }
      },
      {
          "name": "customerGroup2",
          "fetchPlan": "customerGroup-fp"
      }
  ]
 }
 

INCLUDE_FETCH_MODE

public static final FetchPlanSerializationOption INCLUDE_FETCH_MODE

Specifies that an information about properties fetch mode will be included to the JSON. Default fetchMode value (AUTO) will not be included.

Method Detail

values

public static FetchPlanSerializationOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FetchPlanSerializationOption c : FetchPlanSerializationOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FetchPlanSerializationOption valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null