Package com._1c.g5.v8.dt.internal.common

Class CommonPlugin

java.lang.Object
org.eclipse.core.runtime.Plugin
com._1c.g5.v8.dt.internal.common.CommonPlugin
All Implemented Interfaces:
EventListener, org.eclipse.osgi.service.debug.DebugOptionsListener, org.osgi.framework.BundleActivator
public class CommonPlugin extends org.eclipse.core.runtime.Plugin implements org.eclipse.osgi.service.debug.DebugOptionsListener
Common plugin activator.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PLUGIN_ID
    The plug-in ID
    static final String
    TRACE_DEBUG
    Trace option to enable tracing.
    static final String
    TRACE_PROGRESS_STEPS
    Trace option to log when sub-task steps start and finish.
    static final String
    TRACE_PROGRESS_SUBTASKS
    Trace option to log when sub-tasks start and finish.
    static final String
    TRACE_PROGRESS_TASKS
    Trace option to log when tasks start and finish.

    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
    CommonPlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.eclipse.core.runtime.IStatus
    createErrorStatus(String message, Throwable throwable)
    Create error status by given message and cause throwable.
    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 CommonPlugin
    getDefault()
    Returns the shared instance.
    boolean
    isDebugging()
     
    static void
    log(org.eclipse.core.runtime.IStatus status)
    Writes a status to the plugin log.
    static void
    logError(Throwable throwable)
    Writes a throwable to the plugin log as error status.
    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, 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

    • PLUGIN_ID

      public static final String PLUGIN_ID
      The plug-in ID
      See Also:

    • TRACE_DEBUG

      public static final String TRACE_DEBUG
      Trace option to enable tracing.

      If this option is off then other trace options are ignored.

      See Also:

    • TRACE_PROGRESS_TASKS

      public static final String TRACE_PROGRESS_TASKS
      Trace option to log when tasks start and finish.
      See Also:

    • TRACE_PROGRESS_SUBTASKS

      public static final String TRACE_PROGRESS_SUBTASKS
      Trace option to log when sub-tasks start and finish.
      See Also:

    • TRACE_PROGRESS_STEPS

      public static final String TRACE_PROGRESS_STEPS
      Trace option to log when sub-task steps start and finish.
      See Also:

  • Constructor Details

    • CommonPlugin

      public CommonPlugin()

  • Method Details

    • getDefault

      public static CommonPlugin getDefault()
      Returns the shared instance.
      Returns:
      the shared instance, can not be null

    • log

      public static void log(org.eclipse.core.runtime.IStatus status)
      Writes a status to the plugin log.
      Parameters:
      status - status to log, can not be null

    • logError

      public static void logError(Throwable throwable)
      Writes a throwable to the plugin log as error status.
      Parameters:
      throwable - throwable, can 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

    • 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

    • createErrorStatus

      public static org.eclipse.core.runtime.IStatus createErrorStatus(String message, Throwable throwable)
      Create error status by given message and cause throwable.
      Parameters:
      message - status message, can not be null
      throwable - throwable, may be null if not applicable
      Returns:
      status created error status, never 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, 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.

    • isDebugging

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

    • 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