Merge commit 'e1de8d2d152352eded708615a967021db7800709' into lttng-luna

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

diff --git a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfProjectModelElement.java b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfProjectModelElement.java
index 0a596b6f1b830490a8b798366aa16246ed02c42e..042918b8c47ff891baae2e0826b065a86145fb7f 100644 (file)
--- a/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfProjectModelElement.java
+++ b/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfProjectModelElement.java
@@ -1,13 +1,14 @@
 /*******************************************************************************
- * Copyright (c) 2010 Ericsson
- * 
+ * Copyright (c) 2010, 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
- * 
+ *
  * Contributors:
  *   Francois Chouinard - Initial API and implementation
+ *   Bernd Hufmann - Added supplementary files/folder handling
  *******************************************************************************/
 
 package org.eclipse.linuxtools.tmf.ui.project.model;
@@ -24,15 +25,16 @@ import org.eclipse.core.resources.IResourceChangeListener;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IPath;
-import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.NullProgressMonitor;
-import org.eclipse.core.runtime.Status;
-import org.eclipse.linuxtools.internal.tmf.ui.TmfUiPlugin;
+import org.eclipse.linuxtools.internal.tmf.ui.Activator;
 import org.eclipse.linuxtools.tmf.core.TmfCommonConstants;
 
 /**
- * <b><u>TmfProjectModelElement</u></b>
+ * The implementation of the base TMF project model element. It provides default implementation
+ * of the <code>ITmfProjectModelElement</code> interface.
  * <p>
+ * @version 1.0
+ * @author Francois Chouinard
  */
 public abstract class TmfProjectModelElement implements ITmfProjectModelElement, IResourceChangeListener {
 
@@ -41,16 +43,35 @@ public abstract class TmfProjectModelElement implements ITmfProjectModelElement,
     // ------------------------------------------------------------------------
 
     private final String fName;
+    /**
+     * The project model element resource.
+     */
     protected final IResource fResource;
+    /**
+     * The project model resource location (URI)
+     */
     protected final URI fLocation;
+    /**
+     * The project model path of a resource.
+     */
     protected final IPath fPath;
     private final ITmfProjectModelElement fParent;
+    /**
+     * The list of children elements.
+     */
     protected final List<ITmfProjectModelElement> fChildren;
 
     // ------------------------------------------------------------------------
     // Constructor
     // ------------------------------------------------------------------------
-
+    /**
+     * Constructor.
+     *
+     * Creates a base project model element.
+     * @param name The name of the element.
+     * @param resource The element resource.
+     * @param parent The parent model element.
+     */
     protected TmfProjectModelElement(String name, IResource resource, ITmfProjectModelElement parent) {
         fName = name;
         fResource = resource;
@@ -61,6 +82,10 @@ public abstract class TmfProjectModelElement implements ITmfProjectModelElement,
         ResourcesPlugin.getWorkspace().addResourceChangeListener(this);
     }
 
+    private void dispose() {
+        ResourcesPlugin.getWorkspace().removeResourceChangeListener(this);
+    }
+
     // ------------------------------------------------------------------------
     // ITmfProjectModelElement
     // ------------------------------------------------------------------------
@@ -108,6 +133,9 @@ public abstract class TmfProjectModelElement implements ITmfProjectModelElement,
     @Override
     public void removeChild(ITmfProjectModelElement child) {
         fChildren.remove(child);
+        if (child instanceof TmfProjectModelElement) {
+            ((TmfProjectModelElement) child).dispose();
+        }
         refresh();
     }
 
@@ -135,29 +163,29 @@ public abstract class TmfProjectModelElement implements ITmfProjectModelElement,
     public int hashCode() {
         final int prime = 31;
         int result = 1;
-        result = prime * result + ((fLocation == null) ? 0 : fLocation.hashCode());
-        result = prime * result + ((fName == null) ? 0 : fName.hashCode());
         result = prime * result + ((fPath == null) ? 0 : fPath.hashCode());
         return result;
     }
 
     @Override
     public boolean equals(Object other) {
-        if (this == other)
+        if (this == other) {
             return true;
-        if (other == null)
+        }
+        if (other == null) {
             return false;
-        if (!(other instanceof TmfProjectModelElement))
+        }
+        if (!(other instanceof TmfProjectModelElement)) {
             return false;
+        }
         TmfProjectModelElement element = (TmfProjectModelElement) other;
-        return element.fName.equals(fName) && element.fLocation.equals(fLocation);
+        return element.fPath.equals(fPath);
     }
 
-    
     /**
      * Returns the trace specific supplementary directory under the project's supplementary folder.
-     * The folder will be created if it doesn't exist. 
-     * 
+     * The folder will be created if it doesn't exist.
+     *
      * @param supplFoldername - folder name.
      * @return returns the trace specific supplementary directory
      */
@@ -168,19 +196,19 @@ public abstract class TmfProjectModelElement implements ITmfProjectModelElement,
 
     /**
      * Returns the supplementary folder for this project
-     * 
-     * @return the supplementary folder for this project  
+     *
+     * @return the supplementary folder for this project
      */
     public IFolder getSupplementaryFolderParent() {
         TmfProjectElement project = getProject();
-        IProject projectResource = (IProject)project.getResource();
+        IProject projectResource = project.getResource();
         IFolder supplFolderParent = projectResource.getFolder(TmfCommonConstants.TRACE_SUPPLEMENATARY_FOLDER_NAME);
 
         if (!supplFolderParent.exists()) {
             try {
                 supplFolderParent.create(true, true, new NullProgressMonitor());
             } catch (CoreException e) {
-                TmfUiPlugin.getDefault().getLog().log(new Status(IStatus.ERROR, TmfUiPlugin.PLUGIN_ID, "Error creating project specific supplementary folder " + supplFolderParent, e)); //$NON-NLS-1$
+                Activator.getDefault().logError("Error creating project specific supplementary folder " + supplFolderParent, e); //$NON-NLS-1$
             }
         }
         return supplFolderParent;