Package org.eclipse.ecf.core
Class ContainerTypeDescription
- java.lang.Object
- 
- org.eclipse.ecf.core.ContainerTypeDescription
 
- 
 public class ContainerTypeDescription extends Object Description of anIContainertype. Instances of this class are used to representIContainerInstantiators in theContainerFactory- See Also:
- IContainerInstantiator
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected Stringdescriptionprotected inthashCodeprotected booleanhiddenprotected IContainerInstantiatorinstantiatorprotected StringinstantiatorClassprotected Stringnameprotected booleanserver
 - 
Constructor SummaryConstructors Constructor Description ContainerTypeDescription(String name, String instantiatorClass, String description)ContainerTypeDescription(String name, String instantiatorClass, String description, boolean server, boolean hidden)ContainerTypeDescription(String name, IContainerInstantiator instantiator)ContainerTypeDescription(String name, IContainerInstantiator instantiator, String description)ContainerTypeDescription(String name, IContainerInstantiator inst, String desc, boolean server, boolean hidden)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object other)StringgetDescription()Get the String description associated with this ContainerTypeDescription instanceString[]getImportedConfigs(String[] exporterSupportedConfigs)protected IContainerInstantiatorgetInstantiator()StringgetName()Get ContainerTypeDescription nameDictionarygetPropertiesForImportedConfigs(String[] importedConfigs, Dictionary exportedProperties)String[]getSupportedAdapterTypes()Get array of supported adapters for this container type description.String[]getSupportedConfigs()String[]getSupportedIntents()Class[][]getSupportedParameterTypes()Get array of parameter types for this ContainerTypeDescription.inthashCode()booleanisHidden()booleanisServer()StringtoString()protected voidtraceAndLogException(int code, String method, Throwable e)
 
- 
- 
- 
Field Detail- 
nameprotected String name 
 - 
instantiatorClassprotected String instantiatorClass 
 - 
instantiatorprotected IContainerInstantiator instantiator 
 - 
descriptionprotected String description 
 - 
hashCodeprotected int hashCode 
 - 
serverprotected boolean server 
 - 
hiddenprotected boolean hidden 
 
- 
 - 
Constructor Detail- 
ContainerTypeDescriptionpublic ContainerTypeDescription(String name, String instantiatorClass, String description) 
 - 
ContainerTypeDescriptionpublic ContainerTypeDescription(String name, String instantiatorClass, String description, boolean server, boolean hidden) 
 - 
ContainerTypeDescriptionpublic ContainerTypeDescription(String name, IContainerInstantiator instantiator) - Parameters:
- name- name
- instantiator- instantiator
- Since:
- 3.4
 
 - 
ContainerTypeDescriptionpublic ContainerTypeDescription(String name, IContainerInstantiator instantiator, String description) 
 - 
ContainerTypeDescriptionpublic ContainerTypeDescription(String name, IContainerInstantiator inst, String desc, boolean server, boolean hidden) 
 
- 
 - 
Method Detail- 
getNamepublic String getName() Get ContainerTypeDescription name- Returns:
- String name for the ContainerTypeDescription. Will not be null.
 
 - 
getInstantiatorprotected IContainerInstantiator getInstantiator() throws ClassNotFoundException, InstantiationException, IllegalAccessException 
 - 
getDescriptionpublic String getDescription() Get the String description associated with this ContainerTypeDescription instance- Returns:
- String description. May be null.
 
 - 
isServerpublic boolean isServer() 
 - 
isHiddenpublic boolean isHidden() 
 - 
getSupportedAdapterTypespublic String[] getSupportedAdapterTypes() Get array of supported adapters for this container type 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 toIContainer.getAdapter(Class)with the same type name as a returned value will return a non-nullresult. In other words, even if the class name is in the returned array, subsequent calls toIContainer.getAdapter(Class)may still returnnull.- 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. An empty string array (String[0]) will be returned if no adapters are supported.
 
 - 
getSupportedParameterTypespublic Class[][] getSupportedParameterTypes() Get array of parameter types for this ContainerTypeDescription. Each of the rows of the returned array specifies a Class[] of parameter types. These parameter types correspond to the types of Objects that can be passed into the second parameter ofIContainerInstantiator.createInstance(ContainerTypeDescription, Object[]). For example, if this method returns a Class [] = {{ String.class, String.class }, { String.class }} this indicates that a call to createInstance(description,new String[] { "hello", "there" }) and a call to createInstance(description,new String[] { "hello" }) will be understood by the underlying provider implementation.- Returns:
- Class[][] array of Class arrays. Each row corresponds to a
         Class[] that describes the types of Objects for second parameter
         to
         IContainerInstantiator.createInstance(ContainerTypeDescription, Object[]). If no parameter types are understood as arguments, a Class[0][0] array will be returned
 
 - 
getSupportedIntentspublic String[] getSupportedIntents() - Returns:
- String[] of container's intents.
- Since:
- 3.0
 
 - 
getSupportedConfigspublic String[] getSupportedConfigs() - Returns:
- String[] supported configs
- Since:
- 3.1
 
 - 
getImportedConfigspublic String[] getImportedConfigs(String[] exporterSupportedConfigs) - Parameters:
- exporterSupportedConfigs- exporter supported configs
- Returns:
- String[] imported configs
- Since:
- 3.1
 
 - 
getPropertiesForImportedConfigspublic Dictionary getPropertiesForImportedConfigs(String[] importedConfigs, Dictionary exportedProperties) - Parameters:
- importedConfigs- imported configs
- exportedProperties- exported properties
- Returns:
- Dictionary dictionary of properties for imported configs
- Since:
- 3.1
 
 
- 
 
-