org.springframework.cloud.gcp.data.datastore.core.mapping

Enum EmbeddedType

java.lang.Object

java.lang.Enum<EmbeddedType>

org.springframework.cloud.gcp.data.datastore.core.mapping.EmbeddedType

All Implemented Interfaces:

Serializable, Comparable<EmbeddedType>

public enum EmbeddedType
extends Enum<EmbeddedType>

The various types of properties with respect to their storage as embedded entities.

Since:

1.1

Author:

Chengyuan Zhao

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMBEDDED_ENTITY These are properties that are POJOs or collections of POJOs stored as a singular embedded entity or arrays of embedded entities in the field.
EMBEDDED_MAP These are Maps that are stored as a single embedded entity in the field.
NOT_EMBEDDED These are properties that stored as singualr or arrays of Cloud Datastore native field types.

Method Summary

Modifier and Type	Method and Description
static EmbeddedType	of(org.springframework.data.util.TypeInformation typeInformation) Get the EmbeddedType of a given TypeInformation.
static EmbeddedType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EmbeddedType[]	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

NOT_EMBEDDED

public static final EmbeddedType NOT_EMBEDDED

These are properties that stored as singualr or arrays of Cloud Datastore native field types. This excludes the embedded entity field type.

EMBEDDED_ENTITY

public static final EmbeddedType EMBEDDED_ENTITY

These are properties that are POJOs or collections of POJOs stored as a singular embedded entity or arrays of embedded entities in the field.

EMBEDDED_MAP

public static final EmbeddedType EMBEDDED_MAP

These are Maps that are stored as a single embedded entity in the field.

Method Detail

values

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

Returns:

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

valueOf

public static EmbeddedType valueOf(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:

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

NullPointerException - if the argument is null

of

public static EmbeddedType of(org.springframework.data.util.TypeInformation typeInformation)

Get the EmbeddedType of a given TypeInformation.

Parameters:

typeInformation - the given type metadata to check for embedded type.

Returns:

the embedded type.