Uses of Class
com.googlecode.objectify.Key

Packages that use Key

Package	Description
com.googlecode.objectify
com.googlecode.objectify.cmd
com.googlecode.objectify.impl
com.googlecode.objectify.impl.ref
com.googlecode.objectify.impl.translate
com.googlecode.objectify.stringifier
com.googlecode.objectify.util
com.googlecode.objectify.util.jackson

Uses of Key in com.googlecode.objectify

Fields in com.googlecode.objectify declared as Key

Modifier and Type	Field and Description
protected Key<T>	Ref.key The key associated with this ref
protected Key<?>	Key.parent Cache the instance of the parent wrapper to avoid unnecessary garbage

Methods in com.googlecode.objectify that return Key

Modifier and Type	Method and Description
<T> Key<T>	ObjectifyFactory.allocateId(Class<T> clazz) Allocates a single id from the allocator for the specified kind.
<T> Key<T>	ObjectifyFactory.allocateId(Object parentKeyOrEntity, Class<T> clazz) Allocates a single id from the allocator for the specified kind.
static <T> Key<T>	Key.create(Class<? extends T> kindClass, long id) Key.create(Blah.class, id) is easier to type than new Key(Blah.class, id)
static <T> Key<T>	Key.create(Class<? extends T> kindClass, String name) Key.create(Blah.class, name) is easier to type than new Key(Blah.class, name)
static <T> Key<T>	Key.create(com.google.appengine.api.datastore.Key raw) Key.create(key) is easier to type than new Key(key)
static <T> Key<T>	Key.create(Key<?> parent, Class<? extends T> kindClass, long id) Key.create(parent, Blah.class, id) is easier to type than new Key(parent, Blah.class, id)
static <T> Key<T>	Key.create(Key<?> parent, Class<? extends T> kindClass, String name) Key.create(parent, Blah.class, name) is easier to type than new Key(parent, Blah.class, name)
static <T> Key<T>	Key.create(String webSafeString) Key.create(webSafeString) is easier to type than new Key(webSafeString)
static <T> Key<T>	Key.create(T pojo) Create a key from a registered POJO entity.
Key<T>	Ref.getKey() Same as key() but conforms to JavaBeans conventions in case this is being processed by a JSON converter or expression language.
Key<?>	NotFoundException.getKey()
<V> Key<V>	Key.getParent()
<V> Key<V>	Key.getRoot() Gets the root of a parent graph of keys.
Key<T>	Ref.key()
static <V> Key<V>	Key.key(com.google.appengine.api.datastore.Key raw) Easy null-safe conversion of the raw key.
static <T> Key<T>	Key.valueOf(String webSafeString) This is an alias for Key.create(String) which exists for JAX-RS compliance.

Methods in com.googlecode.objectify that return types with arguments of type Key

Modifier and Type	Method and Description
Iterator<Key<T>>	KeyRange.iterator()

Methods in com.googlecode.objectify with parameters of type Key

Modifier and Type	Method and Description
int	Key.compareTo(Key<?> other) Compares based on comparison of the raw key
static <T> Key<T>	Key.create(Key<?> parent, Class<? extends T> kindClass, long id) Key.create(parent, Blah.class, id) is easier to type than new Key(parent, Blah.class, id)
static <T> Key<T>	Key.create(Key<?> parent, Class<? extends T> kindClass, String name) Key.create(parent, Blah.class, name) is easier to type than new Key(parent, Blah.class, name)
static <T> Ref<T>	Ref.create(Key<T> key) Key.create(Blah.class, id) is easier to type than new Key(Blah.class, id)
boolean	Ref.equivalent(Key<T> other) Type safe comparison for key equivalence
boolean	Key.equivalent(Key<T> other) A type-safe equivalence comparison
<T> EntityMetadata<T>	ObjectifyFactory.getMetadata(Key<T> key)
boolean	Objectify.isLoaded(Key<?> key)
static com.google.appengine.api.datastore.Key	Key.key(Key<?> typed) Easy null-safe conversion of the typed key.

Constructors in com.googlecode.objectify with parameters of type Key

Constructor and Description
LoadResult(Key<T> key, Result<T> result)
NotFoundException(Key<?> key) Thrown when we at least know what we are looking for!
Ref(Key<T> key) Create a Ref based on the key, with the specified session

Uses of Key in com.googlecode.objectify.cmd

Methods in com.googlecode.objectify.cmd that return types with arguments of type Key

Modifier and Type	Method and Description
<E> Result<Map<Key<E>,E>>	Saver.entities(E... entities) A convenience method for entities(Iterable)
<E> Map<Key<E>,E>	Loader.entities(E... entities) A convenient substitute for entities(Iterable)
<E> Result<Map<Key<E>,E>>	Saver.entities(Iterable<E> entities) Asynchronously save a batch of entities in the datastore.
<E> Map<Key<E>,E>	Loader.entities(Iterable<E> entities) Load multiple entities from the datastore in a batch.
<E> Result<Key<E>>	Saver.entity(E entity) Asynchronously save a single entity in the datastore.
<E> Map<Key<E>,E>	Loader.keys(Iterable<Key<E>> keys) Load multiple entities by key from the datastore in a batch.
<E> Map<Key<E>,E>	Loader.keys(Key<? extends E>... keys) A convenient substitute for keys(Iterable)
<E> Map<Key<E>,E>	Loader.refs(Iterable<Ref<E>> refs) Load multiple refs in a batch operation.
<E> Map<Key<E>,E>	Loader.refs(Ref<? extends E>... refs) A convenient substitute for refs(Iterable)
<E> Map<Key<E>,E>	Loader.values(Iterable<?> keysOrEntities) Fetch multiple entities from the datastore in a batch.
<E> Map<Key<E>,E>	Loader.values(Object... keysOrEntities) A convenient substitute for values(Iterable)

Methods in com.googlecode.objectify.cmd with parameters of type Key

Modifier and Type	Method and Description
Result<Void>	Deleter.key(Key<?> key) Begin asynchronous deletion of a specific entity.
<E> LoadResult<E>	Loader.key(Key<E> key) Load a single entity by key.
Result<Void>	Deleter.keys(Key<?>... keys) Convenient substitute for keys(Iterable)
<E> Map<Key<E>,E>	Loader.keys(Key<? extends E>... keys) A convenient substitute for keys(Iterable)
<E> E	Loader.now(Key<E> key) Get the entity for a key immediately.

Method parameters in com.googlecode.objectify.cmd with type arguments of type Key

Modifier and Type	Method and Description
Result<Void>	Deleter.keys(Iterable<? extends Key<?>> keys) Begin asynchronous deletion of specific entities.
<E> Map<Key<E>,E>	Loader.keys(Iterable<Key<E>> keys) Load multiple entities by key from the datastore in a batch.

Uses of Key in com.googlecode.objectify.impl

Methods in com.googlecode.objectify.impl that return Key

Modifier and Type	Method and Description
<T> Key<T>	Keys.anythingToKey(Object keyOrEntity) Gets the Key given an object that might be a Key, Key, or entity.
<T> Key<T>	Keys.keyOf(T pojo)

Methods in com.googlecode.objectify.impl that return types with arguments of type Key

Modifier and Type	Method and Description
<E> Result<Map<Key<E>,E>>	SaverImpl.entities(E... entities)
<E> Map<Key<E>,E>	LoaderImpl.entities(E... entities)
<E> Result<Map<Key<E>,E>>	SaverImpl.entities(Iterable<E> entities)
<E> Map<Key<E>,E>	LoaderImpl.entities(Iterable<E> values)
<E> Result<Key<E>>	SaverImpl.entity(E entity)
<E> Map<Key<E>,E>	LoaderImpl.keys(Iterable<Key<E>> keys)
<E> Map<Key<E>,E>	LoaderImpl.keys(Key<? extends E>... keys)
com.google.appengine.api.datastore.QueryResultIterable<Key<T>>	QueryImpl.keysIterable() Get an iterator over the keys.
<T> com.google.appengine.api.datastore.QueryResultIterable<Key<T>>	QueryEngine.queryKeysOnly(com.google.appengine.api.datastore.Query query, com.google.appengine.api.datastore.FetchOptions fetchOpts) Perform a keys-only query.
<E> Map<Key<E>,E>	LoaderImpl.refs(Iterable<Ref<E>> refs)
<E> Map<Key<E>,E>	LoaderImpl.refs(Ref<? extends E>... refs)
<E> Result<Map<Key<E>,E>>	WriteEngine.save(Iterable<? extends E> entities) The fundamental put() operation.
Result<Map<Key<?>,Object>>	LoadEngine.translate(Result<Map<com.google.appengine.api.datastore.Key,com.google.appengine.api.datastore.Entity>> raw) Asynchronously translate raw to processed; might produce successive load operations as refs are filled in
<E> Map<Key<E>,E>	LoaderImpl.values(Iterable<?> values)
<E> Map<Key<E>,E>	LoaderImpl.values(Object... values)

Methods in com.googlecode.objectify.impl with parameters of type Key

Modifier and Type	Method and Description
void	Session.add(Key<?> key, SessionValue<?> value) Add/overwrite a SV.
boolean	Session.contains(Key<?> key)
<T> SessionValue<T>	Session.get(Key<T> key)
<T> KeyMetadata<T>	Keys.getMetadata(Key<T> key)
boolean	ObjectifyImpl.isLoaded(Key<?> key)
<E> LoadResult<E>	LoaderImpl.key(Key<E> key)
<E> Map<Key<E>,E>	LoaderImpl.keys(Key<? extends E>... keys)
<T> Result<T>	LoadEngine.load(Key<T> key) Gets the result, possibly from the session, putting it in the session if necessary.
<T> Ref<T>	LoadEngine.makeRef(Key<?> rootEntity, LoadConditions loadConditions, Key<T> key) Create a Ref for the key, and maybe start a load operation depending on current load groups.
<T> Ref<T>	LoadEngine.makeRef(Key<?> rootEntity, LoadConditions loadConditions, Key<T> key) Create a Ref for the key, and maybe start a load operation depending on current load groups.
<E> E	LoaderImpl.now(Key<E> key)

Method parameters in com.googlecode.objectify.impl with type arguments of type Key

Modifier and Type	Method and Description
<E> Map<Key<E>,E>	LoaderImpl.keys(Iterable<Key<E>> keys)

Constructor parameters in com.googlecode.objectify.impl with type arguments of type Key

Constructor and Description
ChunkingIterator(LoadEngine loadEngine, com.google.appengine.api.datastore.PreparedQuery pq, com.google.appengine.api.datastore.QueryResultIterator<Key<T>> source, int chunkSize)
ChunkIterator(com.google.appengine.api.datastore.QueryResultIterator<Key<T>> allKeys, int chunkSize, LoadEngine engine)

Uses of Key in com.googlecode.objectify.impl.ref

Constructors in com.googlecode.objectify.impl.ref with parameters of type Key

Constructor and Description
DeadRef(Key<T> key) Create a Ref based on the key
DeadRef(Key<T> key, T value) Create a Ref based on the key and value
LiveRef(Key<T> key) Create a Ref based on the key
LiveRef(Key<T> key, Objectify ofy) Create a Ref based on the key, with the specified session

Uses of Key in com.googlecode.objectify.impl.translate

Methods in com.googlecode.objectify.impl.translate that return types with arguments of type Key

Modifier and Type	Method and Description
protected ValueTranslator<Key<?>,com.google.appengine.api.datastore.Key>	KeyTranslatorFactory.createValueTranslator(TypeKey<Key<?>> tk, CreateContext ctx, Path path)

Methods in com.googlecode.objectify.impl.translate with parameters of type Key

Modifier and Type	Method and Description
<T> Ref<T>	LoadContext.loadRef(Key<T> key, LoadConditions loadConditions) Create a Ref for the key, and maybe start a load operation depending on current load groups.
void	LoadContext.setCurrentRoot(Key<?> rootEntity) Sets the current root entity

Method parameters in com.googlecode.objectify.impl.translate with type arguments of type Key

Modifier and Type	Method and Description
protected ValueTranslator<Key<?>,com.google.appengine.api.datastore.Key>	KeyTranslatorFactory.createValueTranslator(TypeKey<Key<?>> tk, CreateContext ctx, Path path)

Uses of Key in com.googlecode.objectify.stringifier

Methods in com.googlecode.objectify.stringifier that return Key

Modifier and Type	Method and Description
Key<?>	KeyStringifier.fromString(String str)

Methods in com.googlecode.objectify.stringifier with parameters of type Key

Modifier and Type	Method and Description
String	KeyStringifier.toString(Key<?> obj)

Uses of Key in com.googlecode.objectify.util

Methods in com.googlecode.objectify.util that return Key

Modifier and Type	Method and Description
static <T> Key<T>	DatastoreUtils.createKey(Key<?> parent, Class<T> kind, Object id) Construct a Key from a Long or String id

Methods in com.googlecode.objectify.util that return types with arguments of type Key

Modifier and Type	Method and Description
static <T> List<Key<T>>	DatastoreUtils.createKeys(Key<?> parent, Class<T> kind, Iterable<?> ids) Make a list of Keys

Methods in com.googlecode.objectify.util with parameters of type Key

Modifier and Type	Method and Description
static <T> Key<T>	DatastoreUtils.createKey(Key<?> parent, Class<T> kind, Object id) Construct a Key from a Long or String id
static <T> List<Key<T>>	DatastoreUtils.createKeys(Key<?> parent, Class<T> kind, Iterable<?> ids) Make a list of Keys
static <S> S	DatastoreUtils.getId(Key<?> key) Gets the String or Long id from the key, or null if incomplete

Uses of Key in com.googlecode.objectify.util.jackson

Methods in com.googlecode.objectify.util.jackson that return Key

Modifier and Type	Method and Description
Key	KeyDeserializer.deserialize(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.databind.DeserializationContext ctxt)

Methods in com.googlecode.objectify.util.jackson with parameters of type Key

Modifier and Type	Method and Description
void	KeySerializer.serialize(Key value, com.fasterxml.jackson.core.JsonGenerator jgen, com.fasterxml.jackson.databind.SerializerProvider provider)
void	KeyKeySerializer.serialize(Key value, com.fasterxml.jackson.core.JsonGenerator jgen, com.fasterxml.jackson.databind.SerializerProvider provider)