Java API ReferenceClass Hierarchy | All Classes | All Fields and Methods

com.ibm.xtools.patterns.framework

Class PatternsFrameworkPlugin

+-- Plugin
      +--  PatternsFrameworkPlugin 

final public Class PatternsFrameworkPlugin
extends Plugin

Represents the patterns framework plug-in class.

This class is used by the patterns framework library and also serves as the class representing the plug-in.


Constructor summary
PatternsFrameworkPlugin()

Creates a new plug-in runtime object.

Method summary
PatternsFrameworkPlugin getDefault()

Represents the static accessor method for retrieving the default shared instance of this plug-in.

String getPluginId()

Retrieves the unique identifier of this plug-in.

IWorkspace getWorkspace()

Returns the workspace instance.

void start( BundleContext bundleContext)

Starts the action.

void stop( BundleContext bundleContext)

Starts the action.

Constructor detail

PatternsFrameworkPlugin

public PatternsFrameworkPlugin()

Creates a new plug-in runtime object.


Method detail

getDefault

static public PatternsFrameworkPlugin getDefault()

Represents the static accessor method for retrieving the default shared instance of this plug-in.

Returns:

The single default shared instance is returned for this plug-in.

getPluginId

static public String getPluginId()

Retrieves the unique identifier of this plug-in.

Returns:

A non-empty string which is unique within the plug-in registry.

getWorkspace

static public IWorkspace getWorkspace()

Returns the workspace instance.

Returns:

The workspace for this plug-in.

start

public void start( BundleContext bundleContext)

Starts the action.

Parameters:

bundleContext
- The context for the action.

Throws:

Exception
- Thrown when a parameter or return value is not valid.

stop

public void stop( BundleContext bundleContext)

Starts the action.

Parameters:

bundleContext
- The context for the action.

Throws:

Exception
- Thrown when a parameter or return value is not valid.


Feedback