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

Class ApplicationsPlugin

java.lang.Object
org.eclipse.core.runtime.Plugin
com.e1c.g5.dt.internal.applications.ApplicationsPlugin
All Implemented Interfaces:
EventListener, org.eclipse.osgi.service.debug.DebugOptionsListener, org.osgi.framework.BundleActivator
public class ApplicationsPlugin extends org.eclipse.core.runtime.Plugin implements org.eclipse.osgi.service.debug.DebugOptionsListener
Applications core 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
    ApplicationsPlugin()
     

  • 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 org.eclipse.core.runtime.IStatus
    createWarningStatus(String message)
    Creates a warning status by the provided message.
    static org.eclipse.core.runtime.IStatus
    createWarningStatus(String message, Throwable throwable)
    Creates a warning status by the provided message and cause throwable.
    static ApplicationsPlugin
    getDefault()
    Returns the shared plug-in instance.
    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
    logDebug(Supplier<String> lazyMessage)
    Logs a 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.
    static void
    logWarning(String message)
    Logs the provided message as WARNIG status.
    static void
    logWarning(String message, Throwable throwable)
    Logs the provided message as WARNIG status.
    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.core.runtime.Plugin

    find, find, getBundle, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, openStream, openStream, savePluginPreferences, setDebugging, shutdown, startup, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ApplicationsPlugin

      public ApplicationsPlugin()

  • Method Details

    • getDefault

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

    • 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

    • createWarningStatus

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

    • createWarningStatus

      public static org.eclipse.core.runtime.IStatus createWarningStatus(String message, Throwable throwable)
      Creates a warning status by the provided message and cause throwable.
      Parameters:
      message - the status message, cannot be null
      throwable - the throwable, can be null if not applicable
      Returns:
      the status created warning 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

    • 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

    • logDebug

      public static void logDebug(Supplier<String> lazyMessage)
      Logs a message as INFO status if plug-in is in debug mode.

      Message is evaluated lazily. That is if plugin is not in debug mode then message is not evaluated to avoid logging overhead.

      Parameters:
      lazyMessage - Lazily evaluates message to be logged. Must not be null.

    • logWarning

      public static void logWarning(String message)
      Logs the provided message as WARNIG status.
      Parameters:
      message - the message to log, cannot be null

    • logWarning

      public static void logWarning(String message, Throwable throwable)
      Logs the provided message as WARNIG status.
      Parameters:
      message - the message to log, cannot be null
      throwable - the cause throwable, can be null if not applicable

    • 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

    • 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.core.runtime.Plugin
      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.core.runtime.Plugin
      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