org.eclipse.ptp.pldt.common

Class CommonPlugin

java.lang.Object

org.eclipse.core.runtime.Plugin

org.eclipse.ui.plugin.AbstractUIPlugin

org.eclipse.ptp.pldt.common.CommonPlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator

public class CommonPlugin
extends org.eclipse.ui.plugin.AbstractUIPlugin

The main plugin class for PLDT (PTP's Parallel Language Development Tools)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_ID

Fields inherited from class org.eclipse.core.runtime.Plugin

PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
CommonPlugin() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static CommonPlugin	getDefault() Returns the shared instance.
static org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor(java.lang.String path) Returns an image descriptor for the image file at the given plug-in relative path.
java.util.List<java.lang.String>	getIncludeDirs(java.lang.String includeID) Returns the preference setting for include paths, as a List of Strings
java.util.ResourceBundle	getResourceBundle() Returns the plugin's resource bundle,
static java.lang.String	getResourceString(java.lang.String key) Returns the string from the plugin's resource bundle, or 'key' if not found.
static org.eclipse.swt.widgets.Display	getStandardDisplay() Returns the standard display to be used.
static boolean	getTraceOn() To use dynamic tracing (User instructions): Create a file ".options" in the same directory as your eclipse executable.
static void	log(int type, java.lang.String msg) Write to the ".log" file
static void	log(java.lang.String msg) Write to the ".log" file with default status type of IStatus.INFO
void	start(org.osgi.framework.BundleContext context) This method is called upon plug-in activation
void	stop(org.osgi.framework.BundleContext context) This method is called when the plug-in is stopped

Methods inherited from class org.eclipse.ui.plugin.AbstractUIPlugin

createImageRegistry, getDialogSettings, getImageRegistry, getPreferenceStore, getWorkbench, imageDescriptorFromPlugin, initializeDefaultPluginPreferences, initializeDefaultPreferences, initializeImageRegistry, loadDialogSettings, loadPreferenceStore, refreshPluginActions, saveDialogSettings, savePreferenceStore, shutdown, startup

Methods inherited from class org.eclipse.core.runtime.Plugin

find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, toString

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_ID

public static final java.lang.String PLUGIN_ID

See Also:

Constant Field Values

Constructor Detail

CommonPlugin

public CommonPlugin()

The constructor.

Method Detail

getTraceOn

public static boolean getTraceOn()

To use dynamic tracing (User instructions): Create a file ".options" in the same directory as your eclipse executable. Put this in the file:

  org.eclipse.ptp.pldt.common/debug = true
  org.eclipse.ptp.pldt.common/debug/pldtTrace = true
 

Then launch eclipse in debug mode using the -debug option, and mirror the Console view output to the command line console using the -consoleLog option. (Maybe Linux already spits out the console, not sure.)

 eclipse - debug - consoleLog
 

When you run with this tracing enabled, it will print out a bunch of trace information to the console. At least MPI artifact analysis has been enabled for user-directed tracing.

Returns:

start

public void start(org.osgi.framework.BundleContext context)
           throws java.lang.Exception

This method is called upon plug-in activation

Specified by:

start in interface org.osgi.framework.BundleActivator

Overrides:

start in class org.eclipse.ui.plugin.AbstractUIPlugin

Throws:

java.lang.Exception

stop

public void stop(org.osgi.framework.BundleContext context)
          throws java.lang.Exception

This method is called when the plug-in is stopped

Specified by:

stop in interface org.osgi.framework.BundleActivator

Overrides:

stop in class org.eclipse.ui.plugin.AbstractUIPlugin

Throws:

java.lang.Exception

getDefault

public static CommonPlugin getDefault()

Returns the shared instance.

getImageDescriptor

public static org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(java.lang.String path)

Returns an image descriptor for the image file at the given plug-in relative path.

Parameters:

path - the path

Returns:

the image descriptor

getStandardDisplay

public static org.eclipse.swt.widgets.Display getStandardDisplay()

Returns the standard display to be used. The method first checks, if the thread calling this method has an associated display. If so, this display is returned. Otherwise the method returns the default display.

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Returns the plugin's resource bundle,

getResourceString

public static java.lang.String getResourceString(java.lang.String key)

Returns the string from the plugin's resource bundle, or 'key' if not found.

log

public static void log(int type,
       java.lang.String msg)

Write to the ".log" file

Parameters:

type - type of log entry, e.g. IStatus.ERROR, IStatus.WARNING, etc.

msg - the message to be displayed

log

public static void log(java.lang.String msg)

Write to the ".log" file with default status type of IStatus.INFO

Parameters:

msg - the message to be displayed.

getIncludeDirs

public java.util.List<java.lang.String> getIncludeDirs(java.lang.String includeID)

Returns the preference setting for include paths, as a List of Strings

Returns:

Since:

5.0