com.googlecode.objectify.impl.translate

Class LoadContext

java.lang.Object

com.googlecode.objectify.impl.translate.LoadContext

public class LoadContext
extends Object

The context of a load operation, which may extend across several entities (for example, a batch).

Constructor Summary

Constructors

Constructor and Description
LoadContext(Loader loader, LoadEngine batch)

Method Summary

Methods

Modifier and Type	Method and Description
void	defer(Runnable runnable) Delays an operation until the context is done().
void	done() Call this when a load process completes.
void	enterOwnerContext(Object owner) Enter an "owner" context; this is the context of the object that we are processing right now.
void	exitOwnerContext(Object expectedOwner) Exit an "owner" context.
Loader	getLoader()
Set<Class<?>>	getLoadGroups() Gets the currently enabled set of load groups
Object	getOwner(Property ownerProp) Get the owner object which is appropriate for the specified property.
<T> Ref<T>	makeRef(Property property, Key<T> key) Create a Ref for the key, and maybe initialize the value depending on the load annotation and the current state of load groups.
void	setCurrentRoot(Key<?> rootEntity) Sets the current root entity

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadContext

public LoadContext(Loader loader,
           LoadEngine batch)

Method Detail

getLoader

public Loader getLoader()

setCurrentRoot

public void setCurrentRoot(Key<?> rootEntity)

Sets the current root entity

done

public void done()

Call this when a load process completes. Executes anything in the batch and then executes any delayed operations.

makeRef

public <T> Ref<T> makeRef(Property property,
                 Key<T> key)

Create a Ref for the key, and maybe initialize the value depending on the load annotation and the current state of load groups. If appropriate, this will also register the ref for upgrade.

defer

public void defer(Runnable runnable)

Delays an operation until the context is done(). Typically this is for lifecycle methods.

getLoadGroups

public Set<Class<?>> getLoadGroups()

Gets the currently enabled set of load groups

getOwner

public Object getOwner(Property ownerProp)

Get the owner object which is appropriate for the specified property. Go up the chain looking for a compatible type; the first one found is the owner. If nothing found, throw an exception - this should be impossible because we validated the class structure when we created the owner.

enterOwnerContext

public void enterOwnerContext(Object owner)

Enter an "owner" context; this is the context of the object that we are processing right now.

exitOwnerContext

public void exitOwnerContext(Object expectedOwner)

Exit an "owner" context. The parameter is just a sanity check to make sure that the value popped off is the same as the value we expect.