com.google.cloud.datastore

Class BaseEntity<K extends IncompleteKey>

java.lang.Object

com.google.cloud.datastore.BaseEntity<K>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FullEntity, ProjectionEntity

public abstract class BaseEntity<K extends IncompleteKey>
extends Object
implements Serializable

A base class for entities (key and properties). An entity is a Google Cloud Datastore persistent data object. An entity holds one or more properties, represented by a name (as String) and a value (as Value), and may be associated with a key. For a list of possible values see ValueType.

See Also:

Google Cloud Datastore Entities, Properties, and Keys, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseEntity.Builder<K extends IncompleteKey,B extends BaseEntity.Builder<K,B>>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String name) Returns true if the entity contains a property with the given name.
boolean	equals(Object obj)
Blob	getBlob(String name) Returns the property value as a blob.
boolean	getBoolean(String name) Returns the property value as a boolean.
DateTime	getDateTime(String name) Returns the property value as a DateTime.
double	getDouble(String name) Returns the property value as a double.
<K extends IncompleteKey> FullEntity<K>	getEntity(String name) Returns the property value as an entity.
Key	getKey(String name) Returns the property value as a Key.
LatLng	getLatLng(String name) Returns the property value as a LatLng.
<T extends Value<?>> List<T>	getList(String name) Returns the property value as a list of values.
long	getLong(String name) Returns the property value as long.
String	getString(String name) Returns the property value as a string.
<V extends Value<?>> V	getValue(String name) Returns the Value for the given property name.
int	hashCode()
boolean	hasKey() Returns true if entity has a non-null key.
boolean	isNull(String name) Returns true if property is an instance of NullValue.
K	key() Returns the associated key or null if it does not have one.
Set<String>	names() Returns the properties name.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hasKey

public boolean hasKey()

Returns true if entity has a non-null key.

key

public K key()

Returns the associated key or null if it does not have one.

contains

public boolean contains(String name)

Returns true if the entity contains a property with the given name.

getValue

public <V extends Value<?>> V getValue(String name)

Returns the Value for the given property name.

Throws:

DatastoreException - if not such property

isNull

public boolean isNull(String name)

Returns true if property is an instance of NullValue.

Throws:

DatastoreException - if not such property

getString

public String getString(String name)

Returns the property value as a string.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a string

getLong

public long getLong(String name)

Returns the property value as long.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a long

getDouble

public double getDouble(String name)

Returns the property value as a double.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a double

getBoolean

public boolean getBoolean(String name)

Returns the property value as a boolean.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a boolean

getDateTime

public DateTime getDateTime(String name)

Returns the property value as a DateTime.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a DateTime

getLatLng

public LatLng getLatLng(String name)

Returns the property value as a LatLng.

Throws:

DatastoreException - if not such property.

ClassCastException - if value is not a LatLng.

getKey

public Key getKey(String name)

Returns the property value as a Key.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a Key

getEntity

public <K extends IncompleteKey> FullEntity<K> getEntity(String name)

Returns the property value as an entity.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not an entity

getList

public <T extends Value<?>> List<T> getList(String name)

Returns the property value as a list of values.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a list of values

getBlob

public Blob getBlob(String name)

Returns the property value as a blob.

Throws:

DatastoreException - if not such property

ClassCastException - if value is not a blob

names

public Set<String> names()

Returns the properties name.