oracle.jdeveloper.deploy.tk

Class ToolkitRegistry

java.lang.Object

oracle.jdeveloper.deploy.tk.ToolkitRegistry

public abstract class ToolkitRegistry
extends java.lang.Object

A registry of Toolkits implementations.

See Also:

Toolkit, ToolkitProvider

Constructor Summary

Constructors

Constructor and Description
ToolkitRegistry()

Method Summary

Modifier and Type	Method and Description
abstract ToolkitBuilder	getBuilder(Context context, java.lang.Class classOrIntf) Same as getBuilder(context.getElement(), context, classOrIntf);
abstract ToolkitBuilder	getBuilder(Element element, Context context, java.lang.Class classOrIntf) Given a Toolkit interface, and a Context, the ToolkitRegistry can be asked to 'build' an object that implements that interface.
static ToolkitRegistry	getInstance()
abstract <T> java.util.List<T>	toolkits(Context context, java.lang.Class<T> classOrIntf) Convenience method that creates a ToolkitBuilder and calls the buildAll method on it.
abstract <T> java.util.List<T>	toolkits(Element element, Context context, java.lang.Class<T> classOrIntf) Convenience method that creates a ToolkitBuilder and calls the buildAll method on it.
abstract java.lang.Class[]	toolkitTypes(Context ideContext, java.lang.Class classOrIntf) Convenience method that returns the sub-types (if any) that each ToolkitProvider can build.
abstract java.lang.Class[]	toolkitTypes(Element element, Context ideContext, java.lang.Class classOrIntf) Convenience method that returns the sub-types (if any) that each ToolkitProvider can build.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolkitRegistry

public ToolkitRegistry()

Method Detail

getInstance

public static ToolkitRegistry getInstance()

getBuilder

public abstract ToolkitBuilder getBuilder(Element element,
                                          Context context,
                                          java.lang.Class classOrIntf)
                                   throws ToolkitBuildException

Given a Toolkit interface, and a Context, the ToolkitRegistry can be asked to 'build' an object that implements that interface. The registry queries all knownToolkitProviders to find the ones that can build. More than one ToolkitProvider may respond, each providing a different implementation of the same interface. If at least one provider is found, a ToolkitBuilder is returned which can then be used to build all or some of the available objects.

Type Parameters:

T -

Parameters:

element -

context -

classOrIntf -

Returns:

Throws:

ToolkitBuildException - if no ToolkitProvider responded to the request.

getBuilder

public abstract ToolkitBuilder getBuilder(Context context,
                                          java.lang.Class classOrIntf)
                                   throws ToolkitBuildException

Same as getBuilder(context.getElement(), context, classOrIntf);

Parameters:

context -

classOrIntf -

Returns:

Throws:

ToolkitBuildException

toolkits

public abstract <T> java.util.List<T> toolkits(Element element,
                                               Context context,
                                               java.lang.Class<T> classOrIntf)
                                        throws ToolkitBuildException

Convenience method that creates a ToolkitBuilder and calls the buildAll method on it.

Type Parameters:

T -

Parameters:

element -

context -

classOrIntf -

Returns:

Throws:

ToolkitBuildException - if no ToolkitProvider responds.

toolkits

public abstract <T> java.util.List<T> toolkits(Context context,
                                               java.lang.Class<T> classOrIntf)
                                        throws ToolkitBuildException

Convenience method that creates a ToolkitBuilder and calls the buildAll method on it.

Type Parameters:

T -

Parameters:

context -

classOrIntf -

Returns:

Throws:

ToolkitBuildException

toolkitTypes

public abstract java.lang.Class[] toolkitTypes(Element element,
                                               Context ideContext,
                                               java.lang.Class classOrIntf)
                                        throws ToolkitBuildException

Convenience method that returns the sub-types (if any) that each ToolkitProvider can build. Use this method only if you wish to examine the classes of toolkits returned without actually constructing them.

Parameters:

element -

ideContext -

classOrIntf -

Returns:

Throws:

ToolkitBuildException

toolkitTypes

public abstract java.lang.Class[] toolkitTypes(Context ideContext,
                                               java.lang.Class classOrIntf)
                                        throws ToolkitBuildException

Convenience method that returns the sub-types (if any) that each ToolkitProvider can build. Use this method only if you wish to examine the classes of toolkits returned without actually constructing them.

Parameters:

ideContext -

classOrIntf -

Returns:

Throws:

ToolkitBuildException