Class MdPlugin

  • All Implemented Interfaces:
    EventListener, org.eclipse.osgi.service.debug.DebugOptionsListener, org.osgi.framework.BundleActivator

    public class MdPlugin
    extends org.eclipse.core.runtime.Plugin
    implements org.eclipse.osgi.service.debug.DebugOptionsListener
    Metadata core plug-in activator. The activator class controls the plug-in life cycle.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String PLUGIN_ID
      Metadata core plug-in identifier.
      • 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
      MdPlugin()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static org.eclipse.core.runtime.IStatus createErrorStatus​(String message)
      Create an error status by the given message.
      static org.eclipse.core.runtime.IStatus createErrorStatus​(String message, Throwable throwable)
      Create an error status by the given message and the cause throwable.
      static org.eclipse.core.runtime.IStatus createWarningStatus​(String message)
      Create a warning status by the given message.
      static org.eclipse.core.runtime.IStatus createWarningStatus​(String message, Throwable throwable)
      Create a warning status by the given message and the cause throwable.
      static MdPlugin getDefault()
      Returns the shared metadata core plug-in instance.
      com.google.inject.Injector getInjector()
      Returns plug-in Guice injector.
      boolean isDebugging()  
      static void log​(org.eclipse.core.runtime.IStatus status)
      Writes a status to log.
      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.
      • Methods inherited from class org.eclipse.core.runtime.Plugin

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

      • MdPlugin

        public MdPlugin()
    • Method Detail

      • getDefault

        public static MdPlugin getDefault()
        Returns the shared metadata core plug-in instance.
        Returns:
        the shared metadata core plug-in instance, never null if plug-in is started
      • log

        public static void log​(org.eclipse.core.runtime.IStatus status)
        Writes a status to log.
        Parameters:
        status - a status to log, cannot be null
      • createErrorStatus

        public static org.eclipse.core.runtime.IStatus createErrorStatus​(String message)
        Create an error status by the given 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)
        Create an error status by the given 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)
        Create a warning status by the given message.
        Parameters:
        message - the status message, cannot be null
        Returns:
        the created error status, never null
      • createWarningStatus

        public static org.eclipse.core.runtime.IStatus createWarningStatus​(String message,
                                                                           Throwable throwable)
        Create a warning status by the given 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
      • 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
      • 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
      • getInjector

        public com.google.inject.Injector getInjector()
        Returns plug-in Guice injector. Method is synchronized.
        Returns:
        the plug-in Guice injector, never null