org.eclipse.ptp.pldt.common
Class CommonPlugin

java.lang.Object
  AbstractUIPlugin
      org.eclipse.ptp.pldt.common.CommonPlugin

public class CommonPlugin
extends AbstractUIPlugin

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

Field Summary

static java.lang.String

PLUGIN_ID

Constructor Summary

CommonPlugin()
The constructor.

Method Summary

static CommonPlugin	getDefault() Returns the shared instance.
static 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 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(BundleContext context) This method is called upon plug-in activation
void	stop(BundleContext context) This method is called when the plug-in is stopped

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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(BundleContext context)
           throws java.lang.Exception

This method is called upon plug-in activation

Throws:

java.lang.Exception

stop

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

This method is called when the plug-in is stopped

Throws:

java.lang.Exception

getDefault

public static CommonPlugin getDefault()

Returns the shared instance.

getImageDescriptor

public static 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 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