classpathhelper.eclipse.ui
Class ClassPathModelExtension

java.lang.Object
  classpathhelper.eclipse.ui.ClassPathModelExtension

public class ClassPathModelExtension

extends java.lang.Object

Object representing a handle to the extensions plugged into the classpathmodels extension point. This object can be used to gather information about the extension as well as instantiating the actual extension object.

Since:

1.0

Author:

bharris

Constructor Summary

ClassPathModelExtension(IConfigurationElement theConfigElement)
Creates the wrapper of the config element.

Method Summary

java.lang.String	getClassName() Returns the class name of the extension.
java.lang.String	getDescription() The description of this extension.
java.lang.String	getId() Gets the ID of this extension.
java.lang.String	getLabel() Gets the label of this extension.
IClassPathModel	getModel() Returns the instance of this extension.
IClassPathModel	getModel(boolean create) Returns the instance of this extension.
java.lang.String	getName() Gets the name of this extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathModelExtension

public ClassPathModelExtension(IConfigurationElement theConfigElement)

Creates the wrapper of the config element.

Parameters:

theConfigElement -

Method Detail

getClassName

public java.lang.String getClassName()

Returns the class name of the extension.

Returns:

The fully qualified class name.

Since:

1.0

getDescription

public java.lang.String getDescription()

The description of this extension.

Returns:

The HTML extension.

Since:

1.0

getId

public java.lang.String getId()

Gets the ID of this extension.

Returns:

The extension definition (should be unique).

Since:

1.0

getLabel

public java.lang.String getLabel()

Gets the label of this extension. This is intended for presentation to the user via the UI to identify this extension.

Returns:

The UI label for this extension.

Since:

1.0

getModel

public IClassPathModel getModel()
                         throws CoreException

Returns the instance of this extension. If the extension is being loaded for the first time the class will be loaded. Subsequent calls to this method will return the same instance.

Returns:

The extension object.

Throws:

CoreException - If the model cannot be instantiated.

Since:

1.0

getModel

public IClassPathModel getModel(boolean create)
                         throws CoreException

Returns the instance of this extension. If the model has already been loaded it will be returned. If the model has not been loaded then it will be created if the create flag is true.

Parameters:

create - true If this method should create a new instance of the model if it does not yet exist. Otherwise false.

Returns:

The extension object or null if create is false and the model has not already been created.

Throws:

CoreException - If the model cannot be instantiated.

Since:

1.0

getName

public java.lang.String getName()

Gets the name of this extension.

Returns:

The name of this extension.

Since:

1.0