Papyrus/Papyrus Developer Guide/Papyrus Log

Papyrus Log is using the log from Eclipse (see [1]). The log are displayed in the "Error Log" view.

Activating Log

To benefit from the Papyrus log mechanism, you must add onto your bundle :

A public static variable on your bundle activator :

       public class Activator extends AbstractUIPlugin {
          
          public static LogHelper log;
          
          public void start(BundleContext context) throws Exception {
               super.start(context);
               plugin = this;
               log = new LogHelper(plugin);
          }
          
       ...
       }

A static import of this variable on your class :

       import static org.eclipse.papyrus.navigator.internal.Activator.log;
       
       public class CreateDiagramAction extends Action {
       
         public void run() {
              log.info("log");
         }
       }

Writing Log

There are three levels of log in Papyrus : info, debug, error

info

  log.info("..."); //$NON-NLS-1$

debug

A debug log is used for development and/or debug purposes only. It MUST be encapsulated with the condition log.isDebugEnabled().

  if (log.isDebugEnabled()) {
      log.debug("Start - CreateDiagramAction#run"); //$NON-NLS-1$
  }

error

 try {
   ...
 } catch (IOException io) {
      log.error("");
      ...
 }