org.eclipse.hyades.ui
Class HyadesUIPlugin

java.lang.Object
  org.eclipse.core.runtime.Plugin
      org.eclipse.ui.plugin.AbstractUIPlugin
          org.eclipse.hyades.ui.HyadesUIPlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator

public class HyadesUIPlugin

extends org.eclipse.ui.plugin.AbstractUIPlugin

Hyades UI Plugin class. This class should not be used outside the context of Eclipse.

Since:

0.0.1

Field Summary

static java.lang.String	EP_ANALYZER_EXTENSIONS Deprecated. use IAssociationConstants.EP_ANALYZER_EXTENSIONS
static java.lang.String	EP_EDITOR_EXTENSIONS Extension point id used to register the editor extensions.
static java.lang.String	EP_SAMPLE_WIZARD Extension point id used to register the sample projects.
static java.lang.String	EP_TYPE_DESCRIPTIONS Deprecated. use IAssociationConstants.EP_TYPE_DESCRIPTIONS
static java.lang.String	EP_TYPE_VALIDATORS Extension point id used to register the type validators.
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

HyadesUIPlugin()
Constructor for HyadesUIPlugin

Method Summary

static java.lang.String	getID() Returns this plugin's id.
static HyadesUIPlugin	getInstance() Returns the instance of this class created by the eclipse framework.
static ILogger	getLogger() Deprecated. use CommonPlugin.getLogger()
java.util.ResourceBundle	getResourceBundle() Returns the resource bundle used by this plugin.
static java.lang.String	getString(java.lang.String key) Returns the "plugin.properties" file's value associate to a given key.
static java.lang.String	getString(java.lang.String key, java.lang.String arg) Returns the string value associate to a given key.
static java.lang.String	getString(java.lang.String key, java.lang.String[] args) Returns the "plugin.properties" file's value associate to a given key.
static void	logError(java.lang.String text) Deprecated. use CommonPlugin.logError(String)
static void	logError(java.lang.Throwable throwable) Deprecated. use CommonPlugin.logError(Throwable)
static void	logInfo(java.lang.String text) Deprecated. use CommonPlugin.logInfo(String)
void	start(org.osgi.framework.BundleContext context)
void	stop(org.osgi.framework.BundleContext context)

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

EP_EDITOR_EXTENSIONS

public static final java.lang.String EP_EDITOR_EXTENSIONS

Extension point id used to register the editor extensions.

See Also:

Constant Field Values

EP_ANALYZER_EXTENSIONS

public static final java.lang.String EP_ANALYZER_EXTENSIONS

Deprecated. use IAssociationConstants.EP_ANALYZER_EXTENSIONS

Extension point id used to register the analyzer extensions.

See Also:

Constant Field Values

EP_TYPE_DESCRIPTIONS

public static final java.lang.String EP_TYPE_DESCRIPTIONS

Deprecated. use IAssociationConstants.EP_TYPE_DESCRIPTIONS

Extension point id used to register the type descriptions.

See Also:

Constant Field Values

EP_TYPE_VALIDATORS

public static final java.lang.String EP_TYPE_VALIDATORS

Extension point id used to register the type validators.

See Also:

Constant Field Values

EP_SAMPLE_WIZARD

public static final java.lang.String EP_SAMPLE_WIZARD

Extension point id used to register the sample projects.

See Also:

Constant Field Values

PLUGIN_ID

public static final java.lang.String PLUGIN_ID

See Also:

Constant Field Values

Constructor Detail

HyadesUIPlugin

public HyadesUIPlugin()

Constructor for HyadesUIPlugin

Method Detail

getInstance

public static HyadesUIPlugin getInstance()

Returns the instance of this class created by the eclipse framework.

Returns:

HyadesUIPlugin

start

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

Throws:

java.lang.Exception

See Also:

BundleActivator.start(org.osgi.framework.BundleContext)

stop

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

Throws:

java.lang.Exception

See Also:

BundleActivator.stop(org.osgi.framework.BundleContext)

getLogger

public static ILogger getLogger()

Deprecated. use CommonPlugin.getLogger()

Returns the an instance of ILogger that used the log methods of this class.

Returns:

ILogger

getID

public static java.lang.String getID()

Returns this plugin's id.

Returns:

String

logError

public static void logError(java.lang.Throwable throwable)

Deprecated. use CommonPlugin.logError(Throwable)

Logs an error described by a throwable.

This method should be used whenever a class in this plugin has to log an error since it adheres to the global logging strategy.

Parameters:

throwable -

logError

public static void logError(java.lang.String text)

Deprecated. use CommonPlugin.logError(String)

Logs an error described by a text.

This method should be whenever a class in this plugin has to log an error since it adheres to the global logging strategy.

Parameters:

text -

logInfo

public static void logInfo(java.lang.String text)

Deprecated. use CommonPlugin.logInfo(String)

Logs an information described by a text.

This method should be whenever a class in this plugin has to log an information since it adheres to the global logging strategy.

Parameters:

text -

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Returns the resource bundle used by this plugin.

IMPORTANT: Don't use this method to retrieve values from the resource bundle. For this purpose use the static getString() defined in this class.

This method is provided so this resource bundle can be used as the parent of another resource bundle.

Returns:

ResourceBundle

getString

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

Returns the "plugin.properties" file's value associate to a given key.

Parameters:

key -

Returns:

String

Throws:

java.util.MissingResourceException - if the key is not in the file

java.lang.NullPointerException - if key is null

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.String arg)

Returns the string value associate to a given key. The key is passed to each resource bundle in the order they are retrieve by the #iterator() method.

The arg string defined replaces the %1 variable defined in the file's values.

Example: If the value associated to the key "a" is "%0 %1 %2 %3 %4" and arg is "v1", the return of this method is "%0 v1 %2 %3 %4".

Parameters:

key -

arg -

Returns:

String

Throws:

java.util.MissingResourceException - if the key is not in the file

java.lang.NullPointerException - if key is null

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.String[] args)

Returns the "plugin.properties" file's value associate to a given key.

The strings defined in args replaces the %n (where n>=1) variables defined in the file's values.

Example: If the value associated to the key "a" is "%0 %1 %2 %3 %4" and args is {"v1", null, "v3"}, the return of this method is "%0 v1 v3 %4".

Parameters:

key -

args -

Returns:

String

Throws:

java.util.MissingResourceException - if the key is not in the file

java.lang.NullPointerException - if key is null