org.drombler.commons.context

Class Contexts

java.lang.Object

org.drombler.commons.context.Contexts

public final class Contexts
extends Object

A utility class for Contexts.

Author:

puce

Method Summary

Modifier and Type	Method and Description
static void	configureObject(Object obj, ContextManager contextManager, ContextInjector contextInjector) Configures the specified object.
static Context	createFixedContext(Collection<?> content) Creates a context with a fixed content.
static Context	emptyContext() Returns an immutable empty Context.
static <T> T	find(Object localContextProvider, Class<T> type) Finds an instance of the specified type in the local context of the provided LocalContextProvider.
static Context	getLocalContext(Object localContextProvider) Gets the local Context of a LocalContextProvider.

Methods inherited from class java.lang.Object

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

Method Detail

emptyContext

public static Context emptyContext()

Returns an immutable empty Context.

Returns:

an immutable empty Context

getLocalContext

public static Context getLocalContext(Object localContextProvider)

Gets the local Context of a LocalContextProvider.

Parameters:

localContextProvider - a LocalContextProvider

Returns:

the local Context of the provided LocalContextProvider

Throws:

ClassCastException - if localContextProvider does not implement LocalContextProvider

find

public static <T> T find(Object localContextProvider,
                         Class<T> type)

Finds an instance of the specified type in the local context of the provided LocalContextProvider. If the local context has more than one instance of the specified type, the first one found will be returned.

Type Parameters:

T - the specified type

Parameters:

localContextProvider - a LocalContextProvider

type - the specified type

Returns:

the first instance found in this context with the specified type, or null if no instance was found or if localContextProvider does not implement LocalContextProvider.

createFixedContext

public static Context createFixedContext(Collection<?> content)

Creates a context with a fixed content.

Parameters:

content - the content

Returns:

a context with a fixed content

configureObject

public static void configureObject(Object obj,
                                   ContextManager contextManager,
                                   ContextInjector contextInjector)

Configures the specified object.

Parameters:

obj - the object

contextManager - the context manager

contextInjector - the context injector

See Also:

ContextManager.registerLocalContext(java.lang.Object), ContextInjector.inject(java.lang.Object)