oracle.jdeveloper.deploy.tk.spi

Interface ToolkitContext

public interface ToolkitContext

The context in which the Toolkit is to be constructed

Method Summary

Methods

Modifier and Type	Method and Description
void	consume() Consume the context.
Element	getElement() The primary Element (if any) for which toolkit is requested.
Context	getIdeContext() The current IDE Context.
ToolkitRegistry	getMainToolkitRegistry() Get the main ToolkitRegistry, i.e.
SpiToolkitRegistry	getSpiToolkitRegistry() If the toolkit provider needs to recurse back into the framework to construct additional toolkits of the same type, with the same Context, then to prevent infinite recursion, the SPI Toolkit Registry should be used.
java.lang.Class	getToolkitClass() The requested interface.

Method Detail

getElement

Element getElement()

The primary Element (if any) for which toolkit is requested.

Returns:

getToolkitClass

java.lang.Class getToolkitClass()

The requested interface. The object thats returned should implement this interface.

Returns:

getIdeContext

Context getIdeContext()

The current IDE Context.

Returns:

getSpiToolkitRegistry

SpiToolkitRegistry getSpiToolkitRegistry()

If the toolkit provider needs to recurse back into the framework to construct additional toolkits of the same type, with the same Context, then to prevent infinite recursion, the SPI Toolkit Registry should be used. This starts the query from a point just below the current ToolkitProvider in the stack.

Returns:

getMainToolkitRegistry

ToolkitRegistry getMainToolkitRegistry()

Get the main ToolkitRegistry, i.e. the registry at the top of the stack. This registry should never be called again with the same Context.

Returns:

consume

void consume()

Consume the context. Stops processing of any more Toolkit Providers after the current one has finished. This should be used only in situations where the current ToolkitProvider can guarantee that any client constructing the original Toolkit with the given IDE Context will not need to query any additional providers past this one (going down the dependency tree, towards the root), OR if it wants to explicitly override all requests and designate itself as the authoritative provider.