com.googlecode.objectify.impl

Class Keys

java.lang.Object

com.googlecode.objectify.impl.Keys

public class Keys
extends Object

Gives us a slightly more organized interface for manipulating keys. While this is part of Objectify's public interface, you probably shouldn't use it. It's subject to change without notice. If you want to work with keys, use the Key.create() methods.

Author:

Jeff Schnitzer

Constructor Summary

Constructors

Constructor and Description
Keys(Registrar registrar)

Method Summary

Modifier and Type	Method and Description
<T> Key<T>	anythingToKey(Object keyOrEntity) Gets the Key given an object that might be a Key, Key, or entity.
com.google.appengine.api.datastore.Key	anythingToRawKey(Object keyOrEntity) Gets the raw datstore Key given an object that might be a Key, Key, or entity.
<T> KeyMetadata<T>	getMetadata(Key<T> key)
<T> KeyMetadata<T>	getMetadataSafe(Class<T> clazz)
<T> KeyMetadata<T>	getMetadataSafe(T pojo)
<T> Key<T>	keyOf(T pojo)
com.google.appengine.api.datastore.Key	rawKeyOf(Object pojo)
boolean	requiresAutogeneratedId(Object entity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Keys

public Keys(Registrar registrar)

Method Detail

keyOf

public <T> Key<T> keyOf(T pojo)

Returns:

the Key for a registered pojo entity.

rawKeyOf

public com.google.appengine.api.datastore.Key rawKeyOf(Object pojo)

Returns:

the native datastore key for a registered pojo entity.

getMetadataSafe

public <T> KeyMetadata<T> getMetadataSafe(Class<T> clazz)

Returns:

the metadata for a registered pojo, or throw exception if none

Throws:

IllegalStateException - if the pojo class has not been registered

getMetadataSafe

public <T> KeyMetadata<T> getMetadataSafe(T pojo)

Returns:

the metadata for a registeerd pojo, or throw exception if none

Throws:

IllegalStateException - if the pojo class has not been registered

getMetadata

public <T> KeyMetadata<T> getMetadata(Key<T> key)

Returns:

the metadata for a registered pojo, or null if there is none

anythingToKey

public <T> Key<T> anythingToKey(Object keyOrEntity)

Gets the Key given an object that might be a Key, Key, or entity.

Parameters:

keyOrEntity - must be a Key, Key, or registered entity.

Throws:

NullPointerException - if keyOrEntity is null

IllegalArgumentException - if keyOrEntity is not a Key, Key, or registered entity

anythingToRawKey

public com.google.appengine.api.datastore.Key anythingToRawKey(Object keyOrEntity)

Gets the raw datstore Key given an object that might be a Key, Key, or entity.

Parameters:

keyOrEntity - must be a Key, Key, or registered entity.

Throws:

NullPointerException - if keyOrEntity is null

IllegalArgumentException - if keyOrEntity is not a Key, Key, or registered entity

requiresAutogeneratedId

public boolean requiresAutogeneratedId(Object entity)

Returns:

true of the entity has a null id which can be autogenerated on save