org.drombler.commons.context

Class ContextManager

java.lang.Object

org.drombler.commons.context.ContextManager

All Implemented Interfaces:

ActiveContextProvider, ApplicationContextProvider

public class ContextManager
extends Object
implements ActiveContextProvider, ApplicationContextProvider

This Context manager allows to register local contexts for objects and manages the Application Context and the current Active Context.

The Active Context provides access to the content of the currently active local Context.

The Application-wide Context provides access to the combined content of all registered local Contexts.

Author:

puce

Constructor Summary

Constructors

Constructor and Description
ContextManager() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
Context	getActiveContext() Gets the active context.
Context	getApplicationContext() Gets the application-wide context.
LocalProxyContext	getLocalContext(Object obj)
void	putLocalContext(Object obj) Registers the local context of the given object if it implements LocalContextProvider.
void	putLocalContext(Object obj, LocalProxyContext context) Registers a local context for the given Object.
LocalProxyContext	removeLocalContext(Object obj) Unregisters a local context.
void	setLocalContextActive(Object obj) Sets a local context active.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextManager

public ContextManager()

Creates a new instance of this class.

Method Detail

getApplicationContext

public Context getApplicationContext()

Gets the application-wide context. It provides access to the combined content of all registered local Contexts.

Specified by:

getApplicationContext in interface ApplicationContextProvider

Returns:

the application-wide context

getActiveContext

public Context getActiveContext()

Gets the active context. It provides access to the content of the currently active local Context.

Specified by:

getActiveContext in interface ActiveContextProvider

Returns:

the active context

setLocalContextActive

public void setLocalContextActive(Object obj)

Sets a local context active. Its content can be accessed from the Active Context. The local context of the specified object has to be registered prior to calling this method.

Parameters:

obj - the object whose local context should be set active

putLocalContext

public void putLocalContext(Object obj,
                            LocalProxyContext context)

Registers a local context for the given Object. Its content will be available from the application-wide context and it can be set active afterwards.

Parameters:

obj - an object

context - the local context of the object

putLocalContext

public void putLocalContext(Object obj)

Registers the local context of the given object if it implements LocalContextProvider. Its content will be available from the application-wide context and it can be set active afterwards.

Parameters:

obj - an object

removeLocalContext

public LocalProxyContext removeLocalContext(Object obj)

Unregisters a local context. Its content won't be available from the application-wide context anymore and it can't be set active anymore.

Parameters:

obj - the object whose local context should be unregistered.

Returns:

the registered context

getLocalContext

public LocalProxyContext getLocalContext(Object obj)