rioko.eclipse.registry

Class RegistryManagement

java.lang.Object

rioko.eclipse.registry.RegistryManagement

public class RegistryManagement
extends java.lang.Object

Static class with some methods used to Manage the Eclipse Registry. It allow to get Attributes from an extension point or instantiate the java objects declared in the registry.

Author:

Antonio

Constructor Summary

Constructors

Constructor and Description
RegistryManagement()

Method Summary

Modifier and Type	Method and Description
static java.lang.Boolean	existsAttribute(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String attribute) Method to know if a element of the Eclipse Registry have an attribute defined.
static java.lang.Boolean	existsId(java.lang.String extensionId) Method to know if exist some elements for an extension point id.
static java.lang.String	getAttribute(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String attribute) Method to get the attribute of a Eclipse Registry Element.
static org.eclipse.core.runtime.IConfigurationElement[]	getElementsFor(java.lang.String extensionId) Generic method to get the Eclipse Registry Elements given a extension id.
static java.lang.Object	getInstance(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String attributeName) Method to get a new instance of the attribute.
static java.lang.Object	getInstance(java.lang.String extensionId, java.lang.String className) Method to get an instance of a class in an extension point using its class canonical name
static <T> T	getInstanceOf(org.eclipse.core.runtime.IConfigurationElement element, java.lang.Class<T> clazz) Method to get the first instance of a class from an element.
static <T> T	getInstanceOf(java.lang.String extensionId, java.lang.Class<T> clazz) Method analogous to getInstance(String, String) but now recieves the Class object instead its canonical name.
static java.util.Collection<java.lang.Object>	getInstances(org.eclipse.core.runtime.IConfigurationElement element) Method to get all the objects instantiables of an element of Eclipse Regsitry
static java.util.Collection<java.lang.Object>	getInstances(java.lang.String extensionId, java.lang.String className) Method to get all the instances of a certain class in an extension point.
static <T> java.util.Collection<T>	getInstancesOf(org.eclipse.core.runtime.IConfigurationElement element, java.lang.Class<T> clazz) Method to get all the instances that extend a given class.
static <T> java.util.Collection<T>	getInstancesOf(java.lang.String extensionId, java.lang.Class<T> clazz) Method that returns all the objects that are instantiable in an extension point and extend the class given.
static java.util.Collection<java.lang.String>	getInstanciableElements(org.eclipse.core.runtime.IConfigurationElement element) Method to get the names of the attributes which are instanciable
static <T> java.lang.Boolean	haveInstancesOf(org.eclipse.core.runtime.IConfigurationElement element, java.lang.Class<T> clazz) Method to know if there is any instantiable object of a certain class.
static java.lang.Boolean	isInstanciable(org.eclipse.core.runtime.IConfigurationElement element) Method to know if an element has any attribute instanciable
static java.lang.Boolean	isIntanciable(org.eclipse.core.runtime.IConfigurationElement element, java.lang.String attributeName) Method to know if an attribute of an Eclipse Registry Element is instanciable

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryManagement

public RegistryManagement()

Method Detail

getElementsFor

public static org.eclipse.core.runtime.IConfigurationElement[] getElementsFor(java.lang.String extensionId)

Generic method to get the Eclipse Registry Elements given a extension id.

Parameters:

extensionId - Name of the extension we want to get.

Returns:

an Array of IConfigurationElement with the elements required

existsId

public static java.lang.Boolean existsId(java.lang.String extensionId)

Method to know if exist some elements for an extension point id.

Parameters:

extensionId - Name of the extension we want to check.

Returns:

Boolean with true if there is an element in the registry with that extension ID

getAttribute

public static java.lang.String getAttribute(org.eclipse.core.runtime.IConfigurationElement element,
                                            java.lang.String attribute)

Method to get the attribute of a Eclipse Registry Element. If it does not exist, returns null. Avoid the exception thrown by the IConfigurationElement method.

Parameters:

element - Eclipse Registry element to search

attribute - Name of the attribute we want to get

Returns:

String associated with attribute in element or null if it does not exist

existsAttribute

public static java.lang.Boolean existsAttribute(org.eclipse.core.runtime.IConfigurationElement element,
                                                java.lang.String attribute)

Method to know if a element of the Eclipse Registry have an attribute defined.

Parameters:

element - Element where we are going to look into

attribute - Name of the attribute we want to search

Returns:

Boolean indicating if element exists in element

getInstanciableElements

public static java.util.Collection<java.lang.String> getInstanciableElements(org.eclipse.core.runtime.IConfigurationElement element)

Method to get the names of the attributes which are instanciable

Parameters:

element - Eclipse Registry Element where we want to get the instanciable elements

Returns:

A Collection with the names of the instanciable attributes

isInstanciable

public static java.lang.Boolean isInstanciable(org.eclipse.core.runtime.IConfigurationElement element)

Method to know if an element has any attribute instanciable

Parameters:

element - Eclipse Registry Element where we want to check

Returns:

Boolean with true if there is an instanciable attribute

isIntanciable

public static java.lang.Boolean isIntanciable(org.eclipse.core.runtime.IConfigurationElement element,
                                              java.lang.String attributeName)

Method to know if an attribute of an Eclipse Registry Element is instanciable

Parameters:

element - Eclipse Registry Element where we want to check

attributeName - String with the name of the attribute we want to check

Returns:

Boolean with true if the attributeName is instanciable for element

getInstance

public static java.lang.Object getInstance(org.eclipse.core.runtime.IConfigurationElement element,
                                           java.lang.String attributeName)

Method to get a new instance of the attribute. Return null if it is not instanciable.

Parameters:

element - The Eclipse Registry Element we want to use

attributeName - String with the name of the attribute we want to instantiate.

Returns:

Object with the new instance or null if attributeName is not instantiable in element

getInstances

public static java.util.Collection<java.lang.Object> getInstances(org.eclipse.core.runtime.IConfigurationElement element)

Method to get all the objects instantiables of an element of Eclipse Regsitry

Parameters:

element - Eclipse Registry Element we want to fully instantiate

Returns:

Collection of Object with the instances possible. It has no null elements and can be an empty collection

getInstanceOf

public static <T> T getInstanceOf(org.eclipse.core.runtime.IConfigurationElement element,
                                  java.lang.Class<T> clazz)

Method to get the first instance of a class from an element. It search throught the instanciable elements and return the first element of the class provided. It is possible give an abstract class and this method returns the first object that extends that abstract class, i.e., this method does not use the constructor of the class given.

Type Parameters:

T - The class we want to search used as a parameter of this method.

Parameters:

element - Eclipse Registry Element we want to use

clazz - Class we want to instantiate.

Returns:

The instance of the object casted to the class given or null if there is no instance of that class.

haveInstancesOf

public static <T> java.lang.Boolean haveInstancesOf(org.eclipse.core.runtime.IConfigurationElement element,
                                                    java.lang.Class<T> clazz)

Method to know if there is any instantiable object of a certain class.

Type Parameters:

T - The class we want to check used as a parameter of this method.

Parameters:

element - Eclipse Registry Element we want to check

clazz - Class we want to search

Returns:

Boolean with true if there is a instance of the class given

getInstancesOf

public static <T> java.util.Collection<T> getInstancesOf(org.eclipse.core.runtime.IConfigurationElement element,
                                                         java.lang.Class<T> clazz)

Method to get all the instances that extend a given class.

Type Parameters:

T - The class we want to instantiate used as a parameter of this method.

Parameters:

element - Eclipse Registry Element we want to use

clazz - Class we want to get

Returns:

A Collection of Objects that extends clazz and are instantiated by element.

getInstance

public static java.lang.Object getInstance(java.lang.String extensionId,
                                           java.lang.String className)

Method to get an instance of a class in an extension point using its class canonical name

Parameters:

extensionId - Identifier of the extension point where we want to search

className - Canonical name of the class we want to instantiate

Returns:

Object of the instance desired if exists and null otherwise

getInstances

public static java.util.Collection<java.lang.Object> getInstances(java.lang.String extensionId,
                                                                  java.lang.String className)

Method to get all the instances of a certain class in an extension point.

Parameters:

extensionId - Identifier of the extension point where we want to search

className - Canonical name of the class we want to instantiate

Returns:

Collection of Objects that are instances of the desired class existing in the extensionId provided

getInstanceOf

public static <T> T getInstanceOf(java.lang.String extensionId,
                                  java.lang.Class<T> clazz)

Method analogous to getInstance(String, String) but now recieves the Class object instead its canonical name. This allows to return subclasses of the given class.

Type Parameters:

T - The class we want to instantiate used as a parameter of this method.

Parameters:

extensionId - Identifier of the extension point where we want to search

clazz - Class we want to find

Returns:

An object that extends the class given.

getInstancesOf

public static <T> java.util.Collection<T> getInstancesOf(java.lang.String extensionId,
                                                         java.lang.Class<T> clazz)

Method that returns all the objects that are instantiable in an extension point and extend the class given.

Type Parameters:

T - The class we want to instantiate used as a parameter of this method.

Parameters:

extensionId - Identifier of the extension point where we want to search

clazz - Class we want to find

Returns:

Collection of Objects that extend the class given that are instantiable in the extensionId