org.eclipse.ecf.core

Class BaseContainer.Instantiator

java.lang.Object

org.eclipse.ecf.core.provider.BaseContainerInstantiator

org.eclipse.ecf.core.BaseContainer.Instantiator

All Implemented Interfaces:

IContainerInstantiator

Enclosing class:

BaseContainer

public static class BaseContainer.Instantiator
extends BaseContainerInstantiator

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class org.eclipse.ecf.core.provider.BaseContainerInstantiator

EMPTY_CLASS_ARRAY, EMPTY_STRING_ARRAY, NO_ADAPTERS_ARRAY

Constructor Summary

Constructors

Constructor and Description
Instantiator()

Method Summary

Modifier and Type	Method and Description
IContainer	createInstance(ContainerTypeDescription description, Object[] parameters) Create instance of IContainer.
String[]	getSupportedAdapterTypes(ContainerTypeDescription description) Get array of supported adapters for the given container type description.
Class[][]	getSupportedParameterTypes(ContainerTypeDescription description) Get array of parameter types for given container type description.

Methods inherited from class org.eclipse.ecf.core.provider.BaseContainerInstantiator

getAdaptersForClass, getIDParameterValue, getIDParameterValue, getIDParameterValue, getIntegerFromArg, getInterfacesAndAdaptersForClass, getInterfacesForClass, getInterfacesForClass, getMap, getMapParameterString, getMapParameterString, getParameterValue, getParameterValue, getParameterValue, getParameterValue, getParameterValue, getStringFromArg, getSupportedIntents

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Since:

3.4

See Also:

Constant Field Values

Constructor Detail

Instantiator

public Instantiator()

Method Detail

createInstance

public IContainer createInstance(ContainerTypeDescription description,
                                 Object[] parameters)
                          throws ContainerCreateException

Description copied from interface: IContainerInstantiator

Create instance of IContainer. This is the interface that container provider implementations must implement for the containerFactory extension point. The caller may optionally specify both argument types and arguments that will be passed into this method (and therefore to the provider implementation implementing this method). For example:

ContainerFactory.getDefault().createContainer("foocontainer",new Object { "hello" });

Specified by:

createInstance in interface IContainerInstantiator

Overrides:

createInstance in class BaseContainerInstantiator

Parameters:

description - the ContainerTypeDescription associated with the registered container provider implementation

parameters - parameters specified by the caller. May be null if no parameters are passed in by caller to ContainerFactory.getDefault().createContainer(...)

Returns:

IContainer instance. The provider implementation must return a valid object implementing IContainer OR throw a ContainerCreateException. Null will not be returned.

Throws:

ContainerCreateException - thrown if instance cannot be created

getSupportedAdapterTypes

public String[] getSupportedAdapterTypes(ContainerTypeDescription description)

Description copied from interface: IContainerInstantiator

Get array of supported adapters for the given container type description. Providers implement this method to allow clients to inspect the adapter types exposed by the container described by the given description. The returned array entries will be the fully qualified names of the adapter classes. Note that the returned types do not guarantee that a subsequent call to IContainer.getAdapter(Class) with the same type name as a returned value will return a non-null result. In other words, even if the class name is in the returned array, subsequent calls to IContainer.getAdapter(Class) may still return null.

Specified by:

getSupportedAdapterTypes in interface IContainerInstantiator

Overrides:

getSupportedAdapterTypes in class BaseContainerInstantiator

Parameters:

description - the ContainerTypeDescription to report adapters for. Must not be null.

Returns:

String[] of supported adapters. The entries in the returned array will be the fully qualified class names of adapters supported by the given description. null may be returned by the provider if no adapters are supported for this description.

getSupportedParameterTypes

public Class[][] getSupportedParameterTypes(ContainerTypeDescription description)

Description copied from interface: IContainerInstantiator

Get array of parameter types for given container type description. Providers implement this method to allow clients to inspect the available set of parameter types understood for calls to IContainerInstantiator.createInstance(ContainerTypeDescription, Object[]).

Each of the rows of the returned array specifies a Class[] of parameter types. These parameter types correspond to the types of Object[] that can be passed into the second parameter of IContainerInstantiator.createInstance(ContainerTypeDescription, Object[]).

Consider the following example:

 public Class[][] getSupportedParameterTypes() {
        return new Class[][] { { String.class }, { String.class, String.class } };
 }
 

The above means that there are two acceptable values for the Object [] passed into IContainerInstantiator.createInstance(ContainerTypeDescription, Object[]): 1) a single String, and 2) two Strings. These would therefore be acceptable as input to createInstance:

 IContainer container = ContainerFactory.getDefault().createContainer(
                description, new Object[] { "Hello" });
 
 IContainer container2 = ContainerFactory.getDefault().createContainer(
                description, new Object[] { "Hello" });
 

Specified by:

getSupportedParameterTypes in interface IContainerInstantiator

Overrides:

getSupportedParameterTypes in class BaseContainerInstantiator

Parameters:

description - the ContainerTypeDescription to return parameter types for

Returns:

Class[][] array of Class[]s. Each row in the table corresponds to a Class[] that describes the types of Objects in Object[] for second parameter to IContainerInstantiator.createInstance(ContainerTypeDescription, Object[]). null returned if no parameter types supported for given description.