sirius.kernel.di

Interface GlobalContext

All Known Subinterfaces:

MutableGlobalContext

public interface GlobalContext

Used to access parts managed by the Injector.

This is the central repository containing all parts managed by the injector. Parts stored inhere can be either accessed via the getPart or findPart methods. Also all annotations processed by an appropriate FieldAnnotationProcessor (like Part) will use this context to find the requested part.

Method Summary

Modifier and Type	Method and Description
<P> P	findPart(String uniqueName, Class<P> clazz) Like getPart(String, Class) this method tried to find the part with the given name, registered for the given lookup class.
<P> Collection<Tuple<String,P>>	getNamedParts(Class<P> partInterface) Returns all parts which are currently registered for the given lookup class and have a name attached.
<P> P	getPart(Class<P> clazz) Finds the previously registered part for the given lookup class.
<P> P	getPart(String uniqueName, Class<P> clazz) Retrieves a part of the requested type with the given unique name.
<P> PartCollection<P>	getPartCollection(Class<P> partInterface) Returns a PartCollection which contains all parts registered for the given lookup class.
<P> Collection<P>	getParts(Class<? extends P> partInterface) Returns all parts which are currently registered for the given lookup class.
<L,P> Collection<P>	getParts(Class<L> lookupClass, Class<? extends P> partType) Returns all parts which are currently registered for the given lookup class.
void	registerDynamicPart(String uniqueName, Object part, Class<?> partInterface) Registers a new part for the given name and lookup classes.
<T> T	wire(T object) Processes all annotations of the given objects class (or super classes).

Method Detail

getPart

@Nullable
<P> P getPart(@Nonnull
                        Class<P> clazz)

Finds the previously registered part for the given lookup class.

If several parts where registered for this class, the first one is chosen. If no part was registered, null is returned.

Type Parameters:

P - the type of the requested part

Parameters:

clazz - the class used to lookup the requested part

Returns:

the first part registered for the given class or null if no part was registered yet.

getPart

@Nullable
<P> P getPart(@Nonnull
                        String uniqueName,
                        @Nonnull
                        Class<P> clazz)

Retrieves a part of the requested type with the given unique name.

If no matching part is found, null is returned.

Type Parameters:

P - the type of the requested part

Parameters:

uniqueName - the name for which the part was registered

clazz - one of the lookup classes for which the part was registered

Returns:

the part which the given unique name, registered for the given class, or null if no matching part was found.

findPart

@Nonnull
<P> P findPart(@Nonnull
                        String uniqueName,
                        @Nonnull
                        Class<P> clazz)

Like getPart(String, Class) this method tried to find the part with the given name, registered for the given lookup class. Rather than returning null when no part is found, this throws a HandledException with an appropriate message.

Type Parameters:

P - the type of the requested part

Parameters:

uniqueName - the name for which the part was registered

clazz - one of the lookup classes for which the part was registered

Returns:

the part which the given unique name, registered for the given class.

Throws:

HandledException - if no matching part was found

getParts

@Nonnull
<L,P> Collection<P> getParts(@Nonnull
                                      Class<L> lookupClass,
                                      @Nonnull
                                      Class<? extends P> partType)

Returns all parts which are currently registered for the given lookup class.

Type Parameters:

L - the type of the lookup class

P - the type of the requested parts

Parameters:

lookupClass - one of the lookup classes for which the parts of interest were registered

partType - the expected type of the parts returned

Returns:

a collection of all parts registered for the given class. If no parts were found, an empty collection is returned

getParts

@Nonnull
<P> Collection<P> getParts(@Nonnull
                                    Class<? extends P> partInterface)

Returns all parts which are currently registered for the given lookup class.

Type Parameters:

P - the type of the requested parts

Parameters:

partInterface - one of the lookup classes for which the parts of interest were registered

Returns:

a collection of all parts registered for the given class. If no parts were found, an empty collection is returned

getNamedParts

@Nonnull
<P> Collection<Tuple<String,P>> getNamedParts(@Nonnull
                                                       Class<P> partInterface)

Returns all parts which are currently registered for the given lookup class and have a name attached.

Type Parameters:

P - the type of the requested parts

Parameters:

partInterface - one of the lookup classes for which the parts of interest were registered

Returns:

a collection of all parts registered for the given class with a name. If no parts were found, an empty collection is returned.

getPartCollection

@Nonnull
<P> PartCollection<P> getPartCollection(@Nonnull
                                                 Class<P> partInterface)

Returns a PartCollection which contains all parts registered for the given lookup class.

Type Parameters:

P - the type of the requested parts

Parameters:

partInterface - one of the lookup classes for which the parts of interest were registered

Returns:

a PartCollection containing all parts registered for the given class. If no parts were found, an empty collection is returned

wire

@Nonnull
<T> T wire(@Nonnull
                    T object)

Processes all annotations of the given objects class (or super classes).

Type Parameters:

T - the type of the object to permit a qualified return type

Parameters:

object - the object which annotations should be processed to fill the respective fields

Returns:

the "wired" object, which has no filled fields. This is just returned for convenience and will not another instance or clone of the given object.

registerDynamicPart

void registerDynamicPart(@Nonnull
                         String uniqueName,
                         @Nonnull
                         Object part,
                         @Nonnull
                         Class<?> partInterface)

Registers a new part for the given name and lookup classes.

In contrast to MutableGlobalContext.registerPart(String, Object, Class[]) this method may replace already existing implementations.

Parameters:

uniqueName - the unique name of the part

part - the part itself

partInterface - the lookup class for which the part is registered