com.googlecode.objectify.impl.ref

Class StdRef<T>

java.lang.Object

com.googlecode.objectify.Ref<T>

com.googlecode.objectify.impl.ref.StdRef<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Ref<T>>

public class StdRef<T>
extends Ref<T>

Standard implementation of a Ref which holds a key and (optionally) a value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Key<T>	key The key associated with this ref
protected Result<T>	result The value associated with the key

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StdRef() For GWT serialization
	StdRef(Key<T> key) Create a Ref based on the key, no value initialized
	StdRef(Key<T> key, T value) Create a Ref based on the key

Method Summary

Methods

Modifier and Type	Method and Description
T	get() Obtain the entity value associated with the key.
T	getValue() Nearly identical to get() but conforms to JavaBean conventions and returns null instead of throwing IllegalStateException if uninitialized.
Key<T>	key()
void	set(Result<T> result) Explicitly sets (or resets) the value of this Ref.

Methods inherited from class com.googlecode.objectify.Ref

compareTo, create, create, create, equals, equivalent, equivalent, getKey, hashCode, safeGet, safeKey, toString

Methods inherited from class java.lang.Object

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

Field Detail

key

protected Key<T> key

The key associated with this ref

result

protected Result<T> result

The value associated with the key

Constructor Detail

StdRef

protected StdRef()

For GWT serialization

StdRef

public StdRef(Key<T> key)

Create a Ref based on the key, no value initialized

StdRef

public StdRef(Key<T> key,
      T value)

Create a Ref based on the key

Method Detail

key

public Key<T> key()

Specified by:

key in class Ref<T>

Returns:

the key associated with this Ref

get

public T get()

Description copied from class: Ref

Obtain the entity value associated with the key.

Specified by:

get in class Ref<T>

Returns:

the entity referenced, or null if the entity was not found

getValue

public T getValue()

Description copied from class: Ref

Nearly identical to get() but conforms to JavaBean conventions and returns null instead of throwing IllegalStateException if uninitialized. This is convenient for use in a JSON converter or an expression language.

Specified by:

getValue in class Ref<T>

Returns:

the entity referenced, or null if either the entity was not found or this Ref is uninitialized

set

public void set(Result<T> result)

Description copied from class: Ref

Explicitly sets (or resets) the value of this Ref.

Specified by:

set in class Ref<T>