tmf: Update copyright headers in tmf.ui
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / internal / tmf / ui / TmfUiTracer.java
index ac123c2225d88a88ada2f9f45128ce86acf354da..8ed4889979489f80e4182c8c8e3a442bab94c6c8 100644 (file)
@@ -1,3 +1,12 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2013 Ericsson
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ *******************************************************************************/
+
 package org.eclipse.linuxtools.internal.tmf.ui;
 
 import java.io.BufferedWriter;
@@ -6,159 +15,228 @@ import java.io.IOException;
 
 import org.eclipse.core.runtime.Platform;
 
+/**
+ * Tracer class for the tmf.ui plugin
+ */
 @SuppressWarnings("nls")
 public class TmfUiTracer {
 
-       private static String pluginID = Activator.PLUGIN_ID;
-
-       static Boolean ERROR     = Boolean.FALSE;
-       static Boolean WARNING   = Boolean.FALSE;
-       static Boolean INFO      = Boolean.FALSE;
-
-       static Boolean INDEX         = Boolean.FALSE;
-       static Boolean DISPLAY       = Boolean.FALSE;
-       static Boolean SORTING       = Boolean.FALSE;
-
-       private static String LOGNAME = "traceUI.log";
-       private static BufferedWriter fTraceLog = null;
-
-       private static BufferedWriter openLogFile(String filename) {
-               BufferedWriter outfile = null;
-               try {
-                       outfile = new BufferedWriter(new FileWriter(filename));
-               } catch (IOException e) {
-                   Activator.getDefault().logError("Error creating log file " + LOGNAME, e); //$NON-NLS-1$
-               }
-               return outfile;
-       }
-
-       public static void init() {
-
-               String traceKey;
-               boolean isTracing = false;
-               
-               traceKey = Platform.getDebugOption(pluginID + "/error");
-               if (traceKey != null) {
-                       ERROR = (Boolean.valueOf(traceKey)).booleanValue();
-                       isTracing |= ERROR;
-               }
-
-               traceKey = Platform.getDebugOption(pluginID + "/warning");
-               if (traceKey != null) {
-                       WARNING = (Boolean.valueOf(traceKey)).booleanValue();
-                       isTracing |= WARNING;
-               }
-
-               traceKey = Platform.getDebugOption(pluginID + "/info");
-               if (traceKey != null) {
-                       INFO = (Boolean.valueOf(traceKey)).booleanValue();
-                       isTracing |= INFO;
-               }
-
-               traceKey = Platform.getDebugOption(pluginID + "/updateindex");
-               if (traceKey != null) {
-                   INDEX = (Boolean.valueOf(traceKey)).booleanValue();
-                       isTracing |= INDEX;
-               }
-
-               traceKey = Platform.getDebugOption(pluginID + "/display");
-               if (traceKey != null) {
-                   DISPLAY = (Boolean.valueOf(traceKey)).booleanValue();
-                       isTracing |= DISPLAY;
-               }
-
-               traceKey = Platform.getDebugOption(pluginID + "/sorting");
-               if (traceKey != null) {
-                   SORTING = (Boolean.valueOf(traceKey)).booleanValue();
-                       isTracing |= SORTING;
-               }
-
-               // Create trace log file if needed
-               if (isTracing) {
-                       fTraceLog = openLogFile(LOGNAME);
-               }
-       }
-
-       public static void stop() {
-               if (fTraceLog == null)
-                       return;
-
-               try {
-                       fTraceLog.close();
-                       fTraceLog = null;
-               } catch (IOException e) {
-                 Activator.getDefault().logError("Error closing log file " + LOGNAME, e); //$NON-NLS-1$
-               }
-       }
-
-       // Predicates
-       public static boolean isErrorTraced() {
-               return ERROR;
-       }
-
-       public static boolean isIndexTraced() {
-               return INDEX;
-       }
-       
-       public static boolean isDisplayTraced() {
-               return DISPLAY;
-       }
-       
-       public static boolean isSortingTraced() {
-               return SORTING;
-       }
-
-       // Tracers
-       public static void trace(String msg) {
-               long currentTime = System.currentTimeMillis();
-               StringBuilder message = new StringBuilder("[");
-               message.append(currentTime / 1000);
-               message.append(".");
-               message.append(String.format("%1$03d", currentTime % 1000));
-               message.append("] ");
-               message.append(msg);
-
-               if (fTraceLog != null) {
-                       try {
-                               fTraceLog.write(message.toString());
-                               fTraceLog.newLine();
-                               fTraceLog.flush();
-                       } catch (IOException e) {
-                        Activator.getDefault().logError("Error writing to log file " + LOGNAME, e); //$NON-NLS-1$
-                       }
-               }
-       }
-
-       public static void traceIndex(String msg) {
-           String message = ("[INDEX] " + msg);
-           trace(message);
-       }
-       
-       public static void traceDisplay(String msg) {
-               String message = ("[DISPLAY]" + msg);
-               trace(message);
-       }
-
-       public static void traceSorting(String msg) {
-               String message = ("[SORT] " + msg);
-               trace(message);
-       }
-
-       public static void traceError(String msg) {
-               String message = ("[ERR] Thread=" + Thread.currentThread().getId() + " " + msg);
-               trace(message);
-       }
-
-       public static void traceWarning(String msg) {
-           String message = ("[WARN] Thread=" + Thread.currentThread().getId() + " " + msg);
-           trace(message);
-       }
-       
-       public static void traceInfo(String msg) {
-               String message = ("[INF] Thread=" + Thread.currentThread().getId() + " " + msg);
-               trace(message);
-       }
-       
-       
+    private static String pluginID = Activator.PLUGIN_ID;
+
+    static Boolean ERROR   = Boolean.FALSE;
+    static Boolean WARNING = Boolean.FALSE;
+    static Boolean INFO    = Boolean.FALSE;
+
+    static Boolean INDEX   = Boolean.FALSE;
+    static Boolean DISPLAY = Boolean.FALSE;
+    static Boolean SORTING = Boolean.FALSE;
+
+    private static String LOGNAME = "traceUI.log";
+    private static BufferedWriter fTraceLog = null;
+
+    private static BufferedWriter openLogFile(String filename) {
+        BufferedWriter outfile = null;
+        try {
+            outfile = new BufferedWriter(new FileWriter(filename));
+        } catch (IOException e) {
+            Activator.getDefault().logError("Error creating log file " + LOGNAME, e); //$NON-NLS-1$
+        }
+        return outfile;
+    }
+
+    /**
+     * Initialize tracing
+     */
+    public static void init() {
+
+        String traceKey;
+        boolean isTracing = false;
+
+        traceKey = Platform.getDebugOption(pluginID + "/error");
+        if (traceKey != null) {
+            ERROR = (Boolean.valueOf(traceKey)).booleanValue();
+            isTracing |= ERROR;
+        }
+
+        traceKey = Platform.getDebugOption(pluginID + "/warning");
+        if (traceKey != null) {
+            WARNING = (Boolean.valueOf(traceKey)).booleanValue();
+            isTracing |= WARNING;
+        }
+
+        traceKey = Platform.getDebugOption(pluginID + "/info");
+        if (traceKey != null) {
+            INFO = (Boolean.valueOf(traceKey)).booleanValue();
+            isTracing |= INFO;
+        }
+
+        traceKey = Platform.getDebugOption(pluginID + "/updateindex");
+        if (traceKey != null) {
+            INDEX = (Boolean.valueOf(traceKey)).booleanValue();
+            isTracing |= INDEX;
+        }
+
+        traceKey = Platform.getDebugOption(pluginID + "/display");
+        if (traceKey != null) {
+            DISPLAY = (Boolean.valueOf(traceKey)).booleanValue();
+            isTracing |= DISPLAY;
+        }
+
+        traceKey = Platform.getDebugOption(pluginID + "/sorting");
+        if (traceKey != null) {
+            SORTING = (Boolean.valueOf(traceKey)).booleanValue();
+            isTracing |= SORTING;
+        }
+
+        // Create trace log file if needed
+        if (isTracing) {
+            fTraceLog = openLogFile(LOGNAME);
+        }
+    }
+
+    /**
+     * Stop tracing
+     */
+    public static void stop() {
+        if (fTraceLog == null) {
+            return;
+        }
+
+        try {
+            fTraceLog.close();
+            fTraceLog = null;
+        } catch (IOException e) {
+            Activator.getDefault().logError("Error closing log file " + LOGNAME, e); //$NON-NLS-1$
+        }
+    }
+
+    // ------------------------------------------------------------------------
+    // Predicates
+    // ------------------------------------------------------------------------
+
+    /**
+     * @return If ERROR messages are traced
+     */
+    public static boolean isErrorTraced() {
+        return ERROR;
+    }
+
+    /**
+     * @return If INDEX messages are traced
+     */
+    public static boolean isIndexTraced() {
+        return INDEX;
+    }
+
+    /**
+     * @return If DISPLAY messages are traced
+     */
+    public static boolean isDisplayTraced() {
+        return DISPLAY;
+    }
+
+    /**
+     * @return If SORTING messages are traced
+     */
+    public static boolean isSortingTraced() {
+        return SORTING;
+    }
+
+
+    // ------------------------------------------------------------------------
+    // Tracing methods
+    // ------------------------------------------------------------------------
+
+    /**
+     * Trace a generic event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void trace(String msg) {
+        long currentTime = System.currentTimeMillis();
+        StringBuilder message = new StringBuilder("[");
+        message.append(currentTime / 1000);
+        message.append(".");
+        message.append(String.format("%1$03d", currentTime % 1000));
+        message.append("] ");
+        message.append(msg);
+
+        if (fTraceLog != null) {
+            try {
+                fTraceLog.write(message.toString());
+                fTraceLog.newLine();
+                fTraceLog.flush();
+            } catch (IOException e) {
+                Activator.getDefault().logError("Error writing to log file " + LOGNAME, e); //$NON-NLS-1$
+            }
+        }
+    }
+
+    /**
+     * Trace an INDEX event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void traceIndex(String msg) {
+        String message = ("[INDEX] " + msg);
+        trace(message);
+    }
+
+    /**
+     * Trace a DISPLAY event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void traceDisplay(String msg) {
+        String message = ("[DISPLAY]" + msg);
+        trace(message);
+    }
+
+    /**
+     * Trace a SORTING event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void traceSorting(String msg) {
+        String message = ("[SORT] " + msg);
+        trace(message);
+    }
+
+    /**
+     * Trace an ERROR event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void traceError(String msg) {
+        String message = ("[ERR] Thread=" + Thread.currentThread().getId() + " " + msg);
+        trace(message);
+    }
+
+    /**
+     * Trace a WARNING event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void traceWarning(String msg) {
+        String message = ("[WARN] Thread=" + Thread.currentThread().getId() + " " + msg);
+        trace(message);
+    }
+
+    /**
+     * Trace an INFO event
+     *
+     * @param msg
+     *            The event's message
+     */
+    public static void traceInfo(String msg) {
+        String message = ("[INF] Thread=" + Thread.currentThread().getId() + " " + msg);
+        trace(message);
+    }
 
 }
This page took 0.039257 seconds and 5 git commands to generate.