io.jmix.core

Enum EntitySerializationOption

java.lang.Object

java.lang.Enum<EntitySerializationOption>

io.jmix.core.EntitySerializationOption

All Implemented Interfaces:

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

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT_REPEATED_ENTITIES If an entity occurs in object graph several times, then the second and next occurrences will be replaced just with a JSON object with the single field - entity identifier.
DO_NOT_SERIALIZE_DENIED_PROPERTY Specifies that not allowed properties should NOT be serialized.
DO_NOT_SERIALIZE_RO_NON_PERSISTENT_PROPERTIES Specifies that read-only non-persistent properties (getter methods annotated with @MetaProperty) should NOT be serialized.
PRETTY_PRINT Specifies that JSON must be pretty printed
SERIALIZE_INSTANCE_NAME Specifies that entity instance name will be serialized.
SERIALIZE_NULLS Specifies that fields with null values should be serialized.
SERIALIZE_SECRET_FIELDS Specifies that fields with io.jmix.core.annotation.Secret annotation should be serialized.

Method Summary

Modifier and Type	Method and Description
static EntitySerializationOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EntitySerializationOption[]	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_REPEATED_ENTITIES

public static final EntitySerializationOption COMPACT_REPEATED_ENTITIES

If an entity occurs in object graph several times, then the second and next occurrences will be replaced just with a JSON object with the single field - entity identifier.

SERIALIZE_NULLS

public static final EntitySerializationOption SERIALIZE_NULLS

Specifies that fields with null values should be serialized. The default behavior is not to serialize nulls.

SERIALIZE_INSTANCE_NAME

public static final EntitySerializationOption SERIALIZE_INSTANCE_NAME

Specifies that entity instance name will be serialized. The default behavior is not to serialize instance name.

DO_NOT_SERIALIZE_RO_NON_PERSISTENT_PROPERTIES

public static final EntitySerializationOption DO_NOT_SERIALIZE_RO_NON_PERSISTENT_PROPERTIES

Specifies that read-only non-persistent properties (getter methods annotated with @MetaProperty) should NOT be serialized.

PRETTY_PRINT

public static final EntitySerializationOption PRETTY_PRINT

Specifies that JSON must be pretty printed

DO_NOT_SERIALIZE_DENIED_PROPERTY

public static final EntitySerializationOption DO_NOT_SERIALIZE_DENIED_PROPERTY

Specifies that not allowed properties should NOT be serialized.

SERIALIZE_SECRET_FIELDS

public static final EntitySerializationOption SERIALIZE_SECRET_FIELDS

Specifies that fields with io.jmix.core.annotation.Secret annotation should be serialized. By default, secret fields are not written to the result JSON.

Method Detail

values

public static EntitySerializationOption[] 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 (EntitySerializationOption c : EntitySerializationOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static EntitySerializationOption 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