Class EmbeddedEntity

java.lang.Object
com.google.appengine.api.datastore.PropertyContainer
com.google.appengine.api.datastore.EmbeddedEntity
All Implemented Interfaces:
Serializable, Cloneable

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);
 
See Also:
  • Constructor Details

    • EmbeddedEntity

      public EmbeddedEntity()
  • Method Details

    • getKey

      public @Nullable Key getKey()
      Returns the key or null.
    • setKey

      public void setKey(@Nullable Key key)
      Parameters:
      key - the key to set
    • clone

      public EmbeddedEntity clone()
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object