Package org.eclipse.e4.core.di.suppliers

Class ExtendedObjectSupplier

java.lang.Object

org.eclipse.e4.core.di.suppliers.ExtendedObjectSupplier

public abstract class ExtendedObjectSupplier
extends java.lang.Object

The base class for an "object supplier" - something that knows how to instantiate objects corresponding to the object descriptor. Extended object suppliers work as a part of an injector, filling in values that primary suppliers don't know about.

If the supplier is asked to track changes, it should notify requestor whenever any of the objects produced by the get(IObjectDescriptor, IRequestor, boolean, boolean) method change. The supplier can do this by performing calls to the IRequestor.resolveArguments(boolean) and IRequestor.execute().

Since:

1.7

See Also:

IRequestor.resolveArguments(boolean), IRequestor.execute()

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERVICE_CONTEXT_KEY	An OSGi service property used to indicate the context key this function should be registered in.
static java.lang.String	SERVICE_NAME	The OSGi service name for an object provider service.

Constructor Summary

Constructors

Constructor	Description
ExtendedObjectSupplier()	Constructs a new instance of an extended object supplier.

Method Summary

Modifier and Type	Method	Description
abstract java.lang.Object	get(IObjectDescriptor descriptor, IRequestor requestor, boolean track, boolean group)	This method is called by the dependency injection mechanism to obtain an object corresponding to the object descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

The OSGi service name for an object provider service. This name can be used to obtain instances of the service.

See Also:

BundleContext.getServiceReference(String)

SERVICE_CONTEXT_KEY

public static final java.lang.String SERVICE_CONTEXT_KEY

An OSGi service property used to indicate the context key this function should be registered in.

See Also:

BundleContext.getServiceReference(String), Constant Field Values

Constructor Detail

ExtendedObjectSupplier

public ExtendedObjectSupplier()

Constructs a new instance of an extended object supplier.

Method Detail

get

public abstract java.lang.Object get(IObjectDescriptor descriptor,
                                     IRequestor requestor,
                                     boolean track,
                                     boolean group)

This method is called by the dependency injection mechanism to obtain an object corresponding to the object descriptor. If the supplier is asked to track changes, it should notify requestor whenever it detects a change that would result in a different result produced by this method.

Parameters:

descriptor - descriptor of the object requested by the requestor

requestor - the originator of this request

track - true if the object suppliers should notify requestor of changes to the returned objects; false otherwise

group - true if the change notifications can be grouped; false otherwise

Returns:

object corresponding to the object descriptor