Class EmbeddedEntity (2.0.0)

public final class EmbeddedEntity extends PropertyContainer

A property value containing embedded entity properties (and optionally a Key).

This class is similar to Entity, but differs in the following ways:

  • #equals(Object) and #hashCode() compare the embedded properties in addition to the Key.
  • It is not queryable when stored in the datastore.
  • A Key is optional.
  • Keys without a name or id are considered equal if all other aspects of the keys are equal (as they will not be assigned IDs by the datastore when embedded).

To convert from an Entity use:


 EmbeddedEntity sv = new EmbeddedEntity();
 sv.setKey(entity.getKey())
 sv.setPropertiesFrom(entity)

To convert to an Entity use:


 Entity entity = new Entity(sv.getKey())
 entity.setPropertiesFrom(sv);

Inheritance

java.lang.Object > PropertyContainer > EmbeddedEntity

Constructors

EmbeddedEntity()

public EmbeddedEntity()

Methods

clone()

public EmbeddedEntity clone()
Returns
TypeDescription
EmbeddedEntity
Overrides

equals(@Nullable Object obj)

public boolean equals(@Nullable Object obj)
Parameter
NameDescription
obj@org.checkerframework.checker.nullness.qual.Nullable java.lang.Object
Returns
TypeDescription
boolean
Overrides

getKey()

public @Nullable Key getKey()

Returns the key or null.

Returns
TypeDescription
@org.checkerframework.checker.nullness.qual.Nullable com.google.appengine.api.datastore.Key

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

setKey(@Nullable Key key)

public void setKey(@Nullable Key key)
Parameter
NameDescription
key@org.checkerframework.checker.nullness.qual.Nullable com.google.appengine.api.datastore.Key

the key to set

toString()

public String toString()
Returns
TypeDescription
String
Overrides