org.wicketeer.modelfactory

Class RequestCycleLocal<T>

java.lang.Object

org.wicketeer.modelfactory.RequestCycleLocal<T>

Type Parameters:

T - Type of the object to store in the RequestCycle.

public class RequestCycleLocal<T>
extends Object

Stores an object with the given key into the RequestCycle. This works basically like a ThreadLocal but uses Wicket's RequestCycle instead of the local Thread as a Context, so that at the end of request-cycle processing, the object is dropped and cannot pop up in another Request (which ThreadLocal could suffer from).

Author:

uweschaefer

Constructor Summary

Constructors

Constructor and Description
RequestCycleLocal(org.apache.wicket.MetaDataKey<T> key)

Method Summary

Modifier and Type	Method and Description
T	get() retrieves the object from the RequestCycle
protected org.apache.wicket.request.cycle.RequestCycle	getRequestCycle() subclasses migt have a different idea how to get the requestCycle.
void	remove() removes the object from the request cycle.
void	set(T t) Set the given object into the RequestCycle's Metadata with the key pass on construction.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestCycleLocal

public RequestCycleLocal(org.apache.wicket.MetaDataKey<T> key)
                  throws NullPointerException

Parameters:

key - used to store the RequestCycleLocal-Object

Throws:

NullPointerException - if the given key is null

Method Detail

getRequestCycle

protected final org.apache.wicket.request.cycle.RequestCycle getRequestCycle()
                                                                      throws IllegalStateException

subclasses migt have a different idea how to get the requestCycle.

Returns:

the currently active RequestCycle

Throws:

IllegalStateException - if there currently is no active RequestCycle. (Remember to use WicketTester in unit-tests)

set

public void set(T t)
         throws NullPointerException

Set the given object into the RequestCycle's Metadata with the key pass on construction.

Parameters:

t - the object to set

Throws:

NullPointerException - if the given object is null. (use remove instead)

get

public T get()

retrieves the object from the RequestCycle

Returns:

the formerly set Object, or null if nothing was not set or the object was removed.

remove

public void remove()

removes the object from the request cycle.