tmf: Simple warning fixes in tmf.ui and tests

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / project / model / TmfNavigatorLabelProvider.java

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfNavigatorLabelProvider.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfNavigatorLabelProvider.java
index 0ae13ec9dc682df26297fe1ba973be48d94ffda9..951b15de52e3a71a8bcbfbd48db9aa748b2c0cac 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfNavigatorLabelProvider.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfNavigatorLabelProvider.java
@@ -1,11 +1,11 @@
 /*******************************************************************************
- * Copyright (c) 2011 Ericsson
- * 
+ * Copyright (c) 2011, 2012 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
- * 
+ *
  * Contributors:
  *   Francois Chouinard - Initial API and implementation
  *******************************************************************************/
@@ -18,7 +18,8 @@ import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.jface.viewers.ILabelProviderListener;
-import org.eclipse.linuxtools.internal.tmf.ui.TmfUiPlugin;
+import org.eclipse.linuxtools.internal.tmf.ui.Activator;
+import org.eclipse.linuxtools.tmf.core.TmfCommonConstants;
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.ui.IMemento;
 import org.eclipse.ui.ISharedImages;
@@ -28,8 +29,10 @@ import org.eclipse.ui.navigator.ICommonLabelProvider;
 import org.osgi.framework.Bundle;
 
 /**
- * <b><u>TmfNavigatorLabelProvider</u></b>
+ * The TMF project label provider for the tree viewer in the project explorer view.
  * <p>
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public class TmfNavigatorLabelProvider implements ICommonLabelProvider {
 
@@ -55,14 +58,19 @@ public class TmfNavigatorLabelProvider implements ICommonLabelProvider {
     // Constructors
     // ------------------------------------------------------------------------
 
+    /**
+     * Constructor.
+     *
+     * Creates the TMF navigator content provider.
+     */
     public TmfNavigatorLabelProvider() {
-        Bundle bundle = TmfUiPlugin.getDefault().getBundle();
+        Bundle bundle = Activator.getDefault().getBundle();
         fDefaultTraceIcon = loadIcon(bundle, fTraceIconFile);
         fExperimentIcon = loadIcon(bundle, fExperimentIconFile);
     }
 
-    private Image loadIcon(Bundle bundle, String url) {
-        TmfUiPlugin plugin = TmfUiPlugin.getDefault();
+    private static Image loadIcon(Bundle bundle, String url) {
+        Activator plugin = Activator.getDefault();
         String key = bundle.getSymbolicName() + "/" + url; //$NON-NLS-1$
         Image icon = plugin.getImageRegistry().get(key);
         if (icon == null) {
@@ -77,7 +85,10 @@ public class TmfNavigatorLabelProvider implements ICommonLabelProvider {
     // ------------------------------------------------------------------------
     // ICommonLabelProvider
     // ------------------------------------------------------------------------
-
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.jface.viewers.ILabelProvider#getImage(java.lang.Object)
+     */
     @Override
     public Image getImage(Object element) {
 
@@ -85,8 +96,8 @@ public class TmfNavigatorLabelProvider implements ICommonLabelProvider {
             TmfTraceElement trace = (TmfTraceElement) element;
             String icon = null;
             try {
-                String name = trace.getResource().getPersistentProperty(TmfTraceElement.TRACEBUNDLE);
-                icon = trace.getResource().getPersistentProperty(TmfTraceElement.TRACEICON);
+                String name = trace.getResource().getPersistentProperty(TmfCommonConstants.TRACEBUNDLE);
+                icon = trace.getResource().getPersistentProperty(TmfCommonConstants.TRACEICON);
                 if (name != null && icon != null) {
                     Bundle bundle = Platform.getBundle(name);
                     return loadIcon(bundle, icon);
@@ -96,18 +107,25 @@ public class TmfNavigatorLabelProvider implements ICommonLabelProvider {
             return fDefaultTraceIcon;
         }
 
-        if (element instanceof TmfExperimentElement)
+        if (element instanceof TmfExperimentElement) {
             return fExperimentIcon;
+        }
 
-        if (element instanceof TmfExperimentFolder)
+        if (element instanceof TmfExperimentFolder) {
             return fExperimentFolderIcon;
+        }
 
-        if (element instanceof TmfTraceFolder)
+        if (element instanceof TmfTraceFolder) {
             return fTraceFolderIcon;
+        }
 
         return null;
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.jface.viewers.ILabelProvider#getText(java.lang.Object)
+     */
     @Override
     public String getText(Object element) {
 
@@ -134,36 +152,68 @@ public class TmfNavigatorLabelProvider implements ICommonLabelProvider {
         return null;
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.jface.viewers.IBaseLabelProvider#addListener(org.eclipse.jface.viewers.ILabelProviderListener)
+     */
     @Override
     public void addListener(ILabelProviderListener listener) {
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.jface.viewers.IBaseLabelProvider#dispose()
+     */
     @Override
     public void dispose() {
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.jface.viewers.IBaseLabelProvider#isLabelProperty(java.lang.Object, java.lang.String)
+     */
     @Override
     public boolean isLabelProperty(Object element, String property) {
         return false;
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.jface.viewers.IBaseLabelProvider#removeListener(org.eclipse.jface.viewers.ILabelProviderListener)
+     */
     @Override
     public void removeListener(ILabelProviderListener listener) {
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.navigator.IMementoAware#restoreState(org.eclipse.ui.IMemento)
+     */
     @Override
     public void restoreState(IMemento aMemento) {
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.navigator.IMementoAware#saveState(org.eclipse.ui.IMemento)
+     */
     @Override
     public void saveState(IMemento aMemento) {
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.navigator.IDescriptionProvider#getDescription(java.lang.Object)
+     */
     @Override
     public String getDescription(Object anElement) {
         return getText(anElement);
     }
 
+    /*
+     * (non-Javadoc)
+     * @see org.eclipse.ui.navigator.ICommonLabelProvider#init(org.eclipse.ui.navigator.ICommonContentExtensionSite)
+     */
     @Override
     public void init(ICommonContentExtensionSite aConfig) {
     }