Package com.e1c.g5.dt.internal.applications.wst.ui

Class WstApplicationsUiPlugin

java.lang.Object
org.eclipse.core.runtime.Plugin
org.eclipse.ui.plugin.AbstractUIPlugin
com.e1c.g5.dt.internal.applications.wst.ui.WstApplicationsUiPlugin
All Implemented Interfaces:
EventListener, org.eclipse.osgi.service.debug.DebugOptionsListener, org.osgi.framework.BundleActivator
public class WstApplicationsUiPlugin extends org.eclipse.ui.plugin.AbstractUIPlugin implements org.eclipse.osgi.service.debug.DebugOptionsListener
WST server applications UI plug-in activator. The activator class controls the plug-in life cycle.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID
    The plug-in identifier.
    static final String
    TRACE_DEBUG
    Trace option to enable tracing.
    static final String
    TRACE_TRACE
    Trace option for generic tracing.

    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
    Description
    WstApplicationsUiPlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.eclipse.core.runtime.IStatus
    createErrorStatus(String message)
    Creates an error status by the provided message.
    static org.eclipse.core.runtime.IStatus
    createErrorStatus(String message, Throwable throwable)
    Creates an error status by the provided message and the cause throwable.
    static org.eclipse.core.runtime.IStatus
    createInfoStatus(String message)
    Creates an info status by the provided message.
    static WstApplicationsUiPlugin
    getDefault()
    Returns the shared plug-in instance.
    static org.eclipse.swt.graphics.Image
    getImage(String symbolicName)
    Returns the registered image for the provided symbolic name.
    static org.eclipse.jface.resource.ImageDescriptor
    getImageDescriptor(String symbolicName)
    Returns the registered image descriptor for the provided symbolic name.
    boolean
    isDebugging()
     
    static void
    log(org.eclipse.core.runtime.IStatus status)
    Writes the status to the plug-in log.
    static void
    logDebug(String message)
    Logs the provided message as INFO status if plug-in is in debug mode.
    static void
    logError(String message)
    Creates and logs an error status by the provided message.
    static void
    logError(String message, Throwable throwable)
    Creates and logs an error status by the provided message and the cause throwable.
    void
    optionsChanged(org.eclipse.osgi.service.debug.DebugOptions options)
     
    void
    start(org.osgi.framework.BundleContext context)
     
    void
    stop(org.osgi.framework.BundleContext context)
     
    static void
    trace(String option, String message)
    Prints the provided message to the OSGi tracing if started and plug-in is in debug mode.
    static void
    trace(String option, String message, Throwable error)
    Prints the provided message to the OSGi tracing if started and plug-in is in debug mode.
    static void
    trace(String option, Supplier<String> messageSupplier)
    Lazily prints a message to the OSGi tracing if started and plug-in is in debug mode.

    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, getLog, getPluginPreferences, getStateLocation, internalInitializeDefaultPluginPreferences, openStream, openStream, savePluginPreferences, setDebugging, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • WstApplicationsUiPlugin

      public WstApplicationsUiPlugin()

  • Method Details

    • getDefault

      public static WstApplicationsUiPlugin getDefault()
      Returns the shared plug-in instance.
      Returns:
      the shared plug-in instance, never null if plug-in is started

    • getImage

      public static org.eclipse.swt.graphics.Image getImage(String symbolicName)
      Returns the registered image for the provided symbolic name.
      Parameters:
      symbolicName - the image name, cannot be null
      Returns:
      an image or null if not found

    • getImageDescriptor

      public static org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(String symbolicName)
      Returns the registered image descriptor for the provided symbolic name.
      Parameters:
      symbolicName - the image name, cannot be null
      Returns:
      an image descriptor or null if not found

    • createInfoStatus

      public static org.eclipse.core.runtime.IStatus createInfoStatus(String message)
      Creates an info status by the provided message.
      Parameters:
      message - the status message, cannot be null
      Returns:
      the status created info status, never null

    • createErrorStatus

      public static org.eclipse.core.runtime.IStatus createErrorStatus(String message)
      Creates an error status by the provided message.
      Parameters:
      message - the status message, cannot be null
      Returns:
      the created error status, never null

    • createErrorStatus

      public static org.eclipse.core.runtime.IStatus createErrorStatus(String message, Throwable throwable)
      Creates an error status by the provided message and the cause throwable.
      Parameters:
      message - the status message, cannot be null
      throwable - the cause throwable, can be null if not applicable
      Returns:
      the created error status, never null

    • log

      public static void log(org.eclipse.core.runtime.IStatus status)
      Writes the status to the plug-in log.
      Parameters:
      status - the status to write to the plug-in log, cannot be null

    • logError

      public static void logError(String message)
      Creates and logs an error status by the provided message.
      Parameters:
      message - the status message, cannot be null

    • logError

      public static void logError(String message, Throwable throwable)
      Creates and logs an error status by the provided message and the cause throwable.
      Parameters:
      message - the status message, cannot be null
      throwable - the cause throwable, can be null if not applicable

    • logDebug

      public static void logDebug(String message)
      Logs the provided message as INFO status if plug-in is in debug mode.
      Parameters:
      message - the message to log, cannot be null

    • trace

      public static void trace(String option, String message)
      Prints the provided message to the OSGi tracing if started and plug-in is in debug mode.
      Parameters:
      option - the option that will control whether the trace statement is printed (e.g., "/debug/myComponent") or null if none
      message - the message to print or null if none

    • trace

      public static void trace(String option, String message, Throwable error)
      Prints the provided message to the OSGi tracing if started and plug-in is in debug mode.
      Parameters:
      option - the option that will control whether the trace statement is printed (e.g., "/debug/myComponent") or null if none
      message - the message to print or null if none
      error - An error to be attached to the traced record or null if none.

    • trace

      public static void trace(String option, Supplier<String> messageSupplier)
      Lazily prints a message to the OSGi tracing if started and plug-in is in debug mode.
      Parameters:
      option - the option that will control whether the trace statement is printed (e.g., "/debug/myComponent") or null if none
      messageSupplier - Supplier of lazy message that is to be printed. Must not be null.

    • start

      public void start(org.osgi.framework.BundleContext context) throws Exception
      Specified by:
      start in interface org.osgi.framework.BundleActivator
      Overrides:
      start in class org.eclipse.ui.plugin.AbstractUIPlugin
      Throws:
      Exception

    • stop

      public void stop(org.osgi.framework.BundleContext context) throws Exception
      Specified by:
      stop in interface org.osgi.framework.BundleActivator
      Overrides:
      stop in class org.eclipse.ui.plugin.AbstractUIPlugin
      Throws:
      Exception

    • optionsChanged

      public void optionsChanged(org.eclipse.osgi.service.debug.DebugOptions options)
      Specified by:
      optionsChanged in interface org.eclipse.osgi.service.debug.DebugOptionsListener

    • isDebugging

      public boolean isDebugging()
      Overrides:
      isDebugging in class org.eclipse.core.runtime.Plugin