org.eclipse.gmt.umlx
Class UmlxPlugin

java.lang.Object
  extended by org.eclipse.emf.common.EMFPlugin
      extended by org.eclipse.gmt.umlx.UmlxPlugin
All Implemented Interfaces:
org.eclipse.emf.common.util.Logger, org.eclipse.emf.common.util.ResourceLocator

public class UmlxPlugin
extends org.eclipse.emf.common.EMFPlugin

This is the central singleton for the Umlx plugin.


Nested Class Summary
static class UmlxPlugin.Implementation
          The actual implementation of the Eclipse Plugin.
 
Nested classes/interfaces inherited from class org.eclipse.emf.common.EMFPlugin
org.eclipse.emf.common.EMFPlugin.EclipsePlugin, org.eclipse.emf.common.EMFPlugin.InternalHelper
 
Field Summary
static IEnvironment environment
          An external environment (that may be varied for unit testing).
static UmlxPlugin INSTANCE
          Keep track of the singleton.
static java.lang.String PLUGIN_ID
          The plugin id
 
Fields inherited from class org.eclipse.emf.common.EMFPlugin
IS_ECLIPSE_RUNNING
 
Constructor Summary
UmlxPlugin()
          Create the instance.
 
Method Summary
static void debugPrintln(java.lang.String message)
          Output a message for debug tracing.
static java.lang.Object getClipboardContents()
           
static UmlxPlugin.Implementation getPlugin()
          Returns the singleton instance of the Eclipse plugin.
 org.eclipse.emf.common.util.ResourceLocator getPluginResourceLocator()
          Returns the singleton instance of the Eclipse plugin.
 java.lang.String getString(java.lang.String key)
           
static boolean isDebugExecution()
          Return true if command execution tracing enabled
static boolean isDebugMarker()
          Return true if marker creation/deletion tracing enabled
static boolean isDebugNotification()
          Return true if notification dispatch tracing enabled
static boolean isDebugNotificationEventType()
          Return true if notification event type print-out enabled
static boolean isDebugNotifier()
          Return true if notifier registration tracing enabled
static boolean isDebugRefresh()
          Return true if refresh dispatch tracing enabled
static boolean isDebugRegimeLoad()
          Return true if regime load tracing enabled
static boolean isDebugSelection()
          Return true if selection tracing enabled
static boolean isDebugViewRegistration()
          Return true if view registration tracing enabled
static void log(org.eclipse.core.runtime.IStatus status, boolean showErrorDialog)
           
static void logBug(java.lang.String string)
           
static void logBug(java.lang.String string, java.lang.Throwable e)
           
static void logError(java.lang.String string)
           
static void logError(java.lang.String string, java.lang.Throwable e)
           
static void logException(java.lang.Throwable e, boolean showErrorDialog)
           
static org.eclipse.core.runtime.CoreException newBug(java.lang.String text, java.lang.Throwable exception)
          Return a CoreException with Bug severity containing a text description and optionally wrapping a further exception.
static org.eclipse.core.runtime.CoreException newError(java.lang.String text, java.lang.Throwable exception)
          Return a CoreException with Error severity containing a text description and optionally wrapping a further exception.
static void openError(java.lang.String errorMessage)
           
static void openError(java.lang.String errorMessage, java.lang.Throwable throwable)
           
static void openMessage(java.lang.String message)
           
static void setClipboardContents(java.lang.Object contents)
           
static void setDebugExecution(boolean debug)
          Configure the command execution tracing option.
static void setDebugMarker(boolean debug)
          Configure the marker creation/deletion tracing option.
static void setDebugNotification(boolean debug)
          Configure the notification dispatch tracing option.
static void setDebugNotificationEventType(boolean debug)
          Configure the notifier event type print-out option.
static void setDebugNotifier(boolean debug)
          Configure the notifier registration tracing option.
static void setDebugRefresh(boolean debug)
          Configure the refresh dispatch tracing option.
static void setDebugRegimeLoad(boolean debug)
          Configure the regime load tracing option.
static void setDebugSelection(boolean debug)
          Configure the selection tracing option.
static void setDebugViewRegistration(boolean debug)
          Configure the view registration tracing option.
 void setOptions()
          Set the configured debug options.
static void showStatus(org.eclipse.core.runtime.IStatus status)
           
 
Methods inherited from class org.eclipse.emf.common.EMFPlugin
getBaseURL, getImage, getPluginLogger, getString, getString, getString, getSymbolicName, log, setShouldTranslate, shouldTranslate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INSTANCE

public static final UmlxPlugin INSTANCE
Keep track of the singleton.


PLUGIN_ID

public static final java.lang.String PLUGIN_ID
The plugin id

See Also:
Constant Field Values

environment

public static IEnvironment environment
An external environment (that may be varied for unit testing).

Constructor Detail

UmlxPlugin

public UmlxPlugin()
Create the instance.

Method Detail

debugPrintln

public static void debugPrintln(java.lang.String message)
Output a message for debug tracing.

Parameters:
message -

getClipboardContents

public static java.lang.Object getClipboardContents()

getPlugin

public static UmlxPlugin.Implementation getPlugin()
Returns the singleton instance of the Eclipse plugin.

Returns:
the singleton instance.

getPluginResourceLocator

public org.eclipse.emf.common.util.ResourceLocator getPluginResourceLocator()
Returns the singleton instance of the Eclipse plugin.

Specified by:
getPluginResourceLocator in class org.eclipse.emf.common.EMFPlugin
Returns:
the singleton instance.

getString

public java.lang.String getString(java.lang.String key)
Specified by:
getString in interface org.eclipse.emf.common.util.ResourceLocator
Overrides:
getString in class org.eclipse.emf.common.EMFPlugin

isDebugExecution

public static boolean isDebugExecution()
Return true if command execution tracing enabled

Returns:
Returns the debugExecution.

isDebugMarker

public static boolean isDebugMarker()
Return true if marker creation/deletion tracing enabled

Returns:
Returns the debugMarker.

isDebugNotification

public static boolean isDebugNotification()
Return true if notification dispatch tracing enabled

Returns:
Returns the debugNotification.

isDebugNotificationEventType

public static boolean isDebugNotificationEventType()
Return true if notification event type print-out enabled

Returns:
Returns the debugNotifier.

isDebugNotifier

public static boolean isDebugNotifier()
Return true if notifier registration tracing enabled

Returns:
Returns the debugNotifier.

isDebugRefresh

public static boolean isDebugRefresh()
Return true if refresh dispatch tracing enabled

Returns:
Returns the debugRegimeLoad.

isDebugRegimeLoad

public static boolean isDebugRegimeLoad()
Return true if regime load tracing enabled

Returns:
Returns the debugRegimeLoad.

isDebugSelection

public static boolean isDebugSelection()
Return true if selection tracing enabled

Returns:
Returns the debugRegimeLoad.

isDebugViewRegistration

public static boolean isDebugViewRegistration()
Return true if view registration tracing enabled

Returns:
Returns the debugViewRegistration.

log

public static void log(org.eclipse.core.runtime.IStatus status,
                       boolean showErrorDialog)

logBug

public static void logBug(java.lang.String string)

logBug

public static void logBug(java.lang.String string,
                          java.lang.Throwable e)

logError

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

logError

public static void logError(java.lang.String string,
                            java.lang.Throwable e)

logException

public static void logException(java.lang.Throwable e,
                                boolean showErrorDialog)

newBug

public static org.eclipse.core.runtime.CoreException newBug(java.lang.String text,
                                                            java.lang.Throwable exception)
Return a CoreException with Bug severity containing a text description and optionally wrapping a further exception.

Parameters:
text - description of exception
exception - optional wrapped exception

newError

public static org.eclipse.core.runtime.CoreException newError(java.lang.String text,
                                                              java.lang.Throwable exception)
Return a CoreException with Error severity containing a text description and optionally wrapping a further exception.

Parameters:
text - description of exception
exception - optional wrapped exception

openError

public static void openError(java.lang.String errorMessage)

openError

public static void openError(java.lang.String errorMessage,
                             java.lang.Throwable throwable)

openMessage

public static void openMessage(java.lang.String message)

setClipboardContents

public static void setClipboardContents(java.lang.Object contents)

setDebugExecution

public static void setDebugExecution(boolean debug)
Configure the command execution tracing option.

Parameters:
debug - true to enable debug tracing

setDebugMarker

public static void setDebugMarker(boolean debug)
Configure the marker creation/deletion tracing option.

Parameters:
debug - true to enable debug tracing

setDebugNotification

public static void setDebugNotification(boolean debug)
Configure the notification dispatch tracing option.

Parameters:
debug - true to enable debug tracing

setDebugNotifier

public static void setDebugNotifier(boolean debug)
Configure the notifier registration tracing option.

Parameters:
debug - true to enable debug tracing

setDebugNotificationEventType

public static void setDebugNotificationEventType(boolean debug)
Configure the notifier event type print-out option.

Parameters:
debug - true to enable debug tracing

setDebugRefresh

public static void setDebugRefresh(boolean debug)
Configure the refresh dispatch tracing option.

Parameters:
debug - true to enable debug tracing

setDebugRegimeLoad

public static void setDebugRegimeLoad(boolean debug)
Configure the regime load tracing option.

Parameters:
debug - true to enable debug tracing

setDebugSelection

public static void setDebugSelection(boolean debug)
Configure the selection tracing option.

Parameters:
debug - true to enable debug tracing

setDebugViewRegistration

public static void setDebugViewRegistration(boolean debug)
Configure the view registration tracing option.

Parameters:
debug - true to enable debug tracing

setOptions

public void setOptions()
Set the configured debug options.


showStatus

public static void showStatus(org.eclipse.core.runtime.IStatus status)