Package net.officefloor.frame.api.thread

Interface OptionalThreadLocal<T>

All Known Implementing Classes:

ThreadLocalImpl.OptionalThreadLocalImpl

public interface OptionalThreadLocal<T>

Provides ThreadLocal access to the ManagedObject object instances.

For applications making use of OfficeFloor functionality this is not typically required. It is provided to enable integration with third party libraries requiring ThreadLocal access to objects.

Author:

Daniel Sagenschneider

See Also:

ThreadDependencyMappingBuilder

Method Summary

Modifier and Type	Method	Description
T	get()	Obtains the object for the respective ManagedObject this represents.

Method Detail

get

T get()

Obtains the object for the respective ManagedObject this represents.

This is optional, for if the ManagedObject is not yet instantiated then this will return null. As ManagedObject instances are asynchronously loaded, they can not be loaded synchronously for this method. Hence, it may return null if the ManagedObject has not been required as a dependency.

To ensure the ManagedObject is available, have the ManagedFunction or ManagedObject using this OptionalThreadLocal depend on the ManagedObject this represents.

Returns:

Object from the ManagedObject or null if ManagedObject not instantiated yet.