Improve Javadoc Comments

14 files changed, 132 insertions, 46 deletions

diff --git a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/src/org/eclipse/papyrus/uml/properties/modelelement/StereotypeModelElement.java b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/src/org/eclipse/papyrus/uml/properties/modelelement/StereotypeModelElement.java
index 22926c67168..2466e1542a1 100644
--- a/plugins/uml/properties/org.eclipse.papyrus.uml.properties/src/org/eclipse/papyrus/uml/properties/modelelement/StereotypeModelElement.java
+++ b/plugins/uml/properties/org.eclipse.papyrus.uml.properties/src/org/eclipse/papyrus/uml/properties/modelelement/StereotypeModelElement.java
@@ -37,6 +37,9 @@ import org.eclipse.uml2.uml.Stereotype;
  */

 public class StereotypeModelElement extends EMFModelElement {

 

+	/**

+	 * The stereotype handled by this ModelElement

+	 */

 	protected Stereotype stereotype;

 

 	/**

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/Activator.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/Activator.java
index 9ad41aaf511..2178c533d67 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/Activator.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/Activator.java
@@ -22,12 +22,17 @@ import org.osgi.framework.BundleContext;
  */

 public class Activator extends AbstractUIPlugin {

 

-	// The plug-in ID

+	/**

+	 * The plug-in ID

+	 */

 	public static final String PLUGIN_ID = "org.eclipse.papyrus.uml.tools"; //$NON-NLS-1$

 

 	// The shared instance

 	private static Activator plugin;

 

+	/**

+	 * The plug-in's logger

+	 */

 	public static LogHelper log;

 

 	/**

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/AbstractStereotypeListener.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/AbstractStereotypeListener.java
index 28d50108abb..fec56b97eda 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/AbstractStereotypeListener.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/AbstractStereotypeListener.java
@@ -16,15 +16,29 @@ import org.eclipse.emf.common.notify.Notification;
 import org.eclipse.emf.common.notify.Notifier;

 import org.eclipse.emf.ecore.EObject;

 import org.eclipse.papyrus.uml.tools.listeners.PapyrusStereotypeListener;

-import org.eclipse.swt.widgets.Listener;

 import org.eclipse.uml2.uml.Element;

 

+/**

+ * An Abstract implementation of a stereotype application listener.

+ * This object will listener on

+ * 

+ * @author Camille Letavernier

+ * 

+ */

 public abstract class AbstractStereotypeListener implements Adapter {

 

 	private Element umlElement;

 

 	private Notifier target;

 

+	/**

+	 * Constructors

+	 * 

+	 * Adds a Stereotype application listener to the given UML Element

+	 * 

+	 * @param umlElement

+	 *        The observed UML Element

+	 */

 	public AbstractStereotypeListener(Element umlElement) {

 		this.umlElement = umlElement;

 		umlElement.eAdapters().add(this);

@@ -47,17 +61,23 @@ public abstract class AbstractStereotypeListener implements Adapter {
 		}

 	}

 

-	protected abstract void handleUnappliedStereotype(EObject newValue);

+	/**

+	 * Notifies this listener that a stereotype has been unapplied from

+	 * the observed UML Element

+	 * 

+	 * @param unappliedStereotype

+	 *        The stereotype which has been unapplied

+	 */

+	protected abstract void handleUnappliedStereotype(EObject unappliedStereotype);

 

-	protected abstract void handleAppliedStereotype(EObject newValue);

-

-	public void addChangeListener(Listener listener) {

-		//Nothing

-	}

-

-	public void removeChangeListener(Listener listener) {

-		//Nothing

-	}

+	/**

+	 * Notifies this listener that a stereotype has been applied from

+	 * the observed UML Element

+	 * 

+	 * @param appliedStereotype

+	 *        The new applied stereotype

+	 */

+	protected abstract void handleAppliedStereotype(EObject appliedStereotype);

 

 	public Notifier getTarget() {

 		return target;

@@ -71,6 +91,9 @@ public abstract class AbstractStereotypeListener implements Adapter {
 		return false;

 	}

 

+	/**

+	 * Disposes this stereotype application listener

+	 */

 	public void dispose() {

 		umlElement.eAdapters().remove(this);

 		for(EObject eObject : umlElement.getStereotypeApplications()) {

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/MultiplicityObservableValue.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/MultiplicityObservableValue.java
index 4bd516ba84e..32c9a39f7fc 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/MultiplicityObservableValue.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/MultiplicityObservableValue.java
@@ -170,7 +170,7 @@ public class MultiplicityObservableValue extends AbstractObservableValue impleme
 	}

 

 	@Override

-	public void dispose() {

+	public synchronized void dispose() {

 		lowerValue.removeChangeListener(this);

 		upperValue.removeChangeListener(this);

 		if(lowerValueSpecification != null) {

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/NavigationObservableValue.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/NavigationObservableValue.java
index 25176ba2402..d2fff73971a 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/NavigationObservableValue.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/NavigationObservableValue.java
@@ -91,7 +91,7 @@ public class NavigationObservableValue extends AbstractObservableValue implement
 	}

 

 	@Override

-	public void dispose() {

+	public synchronized void dispose() {

 		super.dispose();

 		ownerObservableList.removeChangeListener(this);

 		ownerObservableList.dispose();

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/OwnerObservableValue.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/OwnerObservableValue.java
index 343ddd8424c..05c7f10339e 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/OwnerObservableValue.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/OwnerObservableValue.java
@@ -114,7 +114,7 @@ public class OwnerObservableValue extends AbstractObservableValue implements ICh
 	}

 

 	@Override

-	public void dispose() {

+	public synchronized void dispose() {

 		super.dispose();

 		navigableEndsObservableList.removeChangeListener(this);

 		navigableEndsObservableList.dispose();

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/PapyrusObservableList.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/PapyrusObservableList.java
index 7612cfaf66e..2c3945d4aba 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/PapyrusObservableList.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/PapyrusObservableList.java
@@ -70,18 +70,18 @@ public class PapyrusObservableList extends EMFObservableList {
 	 * Creates an EMF command from a GMF request, with the given IElementEditService

 	 * 

 	 * @param provider

-	 * @param request

+	 * @param requests

 	 * @return

 	 *         The EMF command corresponding to the given request

 	 */

 	protected Command getCommandFromRequests(IElementEditService provider, Collection<? extends IEditCommandRequest> requests) {

-		if (requests.size() == 1) {

+		if(requests.size() == 1) {

 			return new GMFtoEMFCommandWrapper(provider.getEditCommand(requests.iterator().next()));

 		}

 

 		CompositeCommand cc = new CompositeCommand("Edit list");

 

-		for (IEditCommandRequest request : requests) {

+		for(IEditCommandRequest request : requests) {

 			ICommand cmd = provider.getEditCommand(request);

 			cc.add(cmd);

 		}

@@ -239,16 +239,18 @@ public class PapyrusObservableList extends EMFObservableList {
 	/**

 	 * Compute the requests

 	 * 

-	 * @param newValues the new list that will be set as a value of the observed feature

-	 * @param removedValues if element has been removed from the list put it there : it handles destroy of elements if the observed feature is a containment

+	 * @param newValues

+	 *        the new list that will be set as a value of the observed feature

+	 * @param removedValues

+	 *        if element has been removed from the list put it there : it handles destroy of elements if the observed feature is a containment

 	 * @return

 	 */

 	protected Collection<? extends IEditCommandRequest> getRequests(List<Object> newValues, Collection<?> removedValues) {

 		LinkedList<IEditCommandRequest> requests = new LinkedList<IEditCommandRequest>();

 

-		if (feature instanceof EReference && ((EReference)feature).isContainment() && removedValues != null) {

-			for (Object o : removedValues) {

-				if (o instanceof EObject) {

+		if(feature instanceof EReference && ((EReference)feature).isContainment() && removedValues != null) {

+			for(Object o : removedValues) {

+				if(o instanceof EObject) {

 					requests.add(new DestroyElementRequest((TransactionalEditingDomain)editingDomain, (EObject)o, false));

 				}

 			}

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/ProfileApplicationObservableList.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/ProfileApplicationObservableList.java
index 8fae850b406..4aaa16ff532 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/ProfileApplicationObservableList.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/databinding/ProfileApplicationObservableList.java
@@ -124,7 +124,7 @@ public class ProfileApplicationObservableList extends WritableList implements IC
 	}

 

 	@Override

-	public void dispose() {

+	public synchronized void dispose() {

 		super.dispose();

 		this.listener.dispose();

 	}

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/helper/UMLDatabindingHelper.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/helper/UMLDatabindingHelper.java
index 19f4c63f16e..f16adcce1d6 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/helper/UMLDatabindingHelper.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/helper/UMLDatabindingHelper.java
@@ -1,3 +1,14 @@
+/*****************************************************************************

+ * Copyright (c) 2012 CEA LIST.

+ * 

+ * 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:

+ *  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation

+ *****************************************************************************/

 package org.eclipse.papyrus.uml.tools.helper;

 

 import org.eclipse.core.databinding.observable.value.IObservableValue;

@@ -7,7 +18,11 @@ import org.eclipse.emf.ecore.EStructuralFeature;
 import org.eclipse.emf.edit.domain.EditingDomain;

 import org.eclipse.papyrus.uml.tools.databinding.PapyrusObservableValue;

 

-

+/**

+ * A Helper class for UML Databinding

+ * 

+ * @author Camille Letavernier

+ */

 public class UMLDatabindingHelper {

 

 	/**

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/EditServiceValidator.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/EditServiceValidator.java
index 53774f2c6d6..5268bfe6746 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/EditServiceValidator.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/EditServiceValidator.java
@@ -1,17 +1,33 @@
-/*

+/*****************************************************************************

+ * Copyright (c) 2012 CEA LIST.

  * 

- */

+ * 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:

+ *  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation

+ *****************************************************************************/

 package org.eclipse.papyrus.uml.tools.providers;

 

-import org.eclipse.core.runtime.IAdaptable;

 import org.eclipse.emf.ecore.EObject;

 import org.eclipse.emf.ecore.EStructuralFeature;

 import org.eclipse.gmf.runtime.emf.core.util.EMFCoreUtil;

 import org.eclipse.gmf.runtime.emf.type.core.requests.SetRequest;

+import org.eclipse.papyrus.infra.emf.utils.EMFHelper;

 import org.eclipse.papyrus.infra.services.edit.service.ElementEditServiceUtils;

 import org.eclipse.papyrus.infra.services.edit.service.IElementEditService;

+import org.eclipse.papyrus.uml.tools.Activator;

 

-

+/**

+ * A Validator based on the Papyrus EditService

+ * Tests whether a given Object is a valid value for a specific

+ * feature on an EObject

+ * 

+ * @author Camille Letavernier

+ * 

+ */

 public class EditServiceValidator {

 

 	private EObject editedEObject;

@@ -20,6 +36,12 @@ public class EditServiceValidator {
 

 	private IElementEditService editingService;

 

+	/**

+	 * Constructor

+	 * 

+	 * @param editedEObject

+	 * @param editedFeature

+	 */

 	public EditServiceValidator(EObject editedEObject, EStructuralFeature editedFeature) {

 		this.editedEObject = editedEObject;

 		this.editedFeature = editedFeature;

@@ -30,13 +52,21 @@ public class EditServiceValidator {
 

 		if(this.editingService == null) {

 			// log error service not found...

-			System.err.println("Could not create service for " + EMFCoreUtil.getQualifiedName(editedEObject, true));

+			Activator.log.warn("Could not create service for " + EMFCoreUtil.getQualifiedName(editedEObject, true));

 		}

 	}

 

+	/**

+	 * Tests whether the given element is a valid value,

+	 * i.e. can be used as a value to edit this EObject/Feature pair

+	 * 

+	 * @param element

+	 * @return

+	 *         True if the given element is valid

+	 */

 	public boolean isValidValue(Object element) {

 		// Get semantic element

-		EObject semanticElement = getSemanticElement(element);

+		EObject semanticElement = EMFHelper.getEObject(element);

 		if((semanticElement == null) && (element != null)) {

 			return false;

 		}

@@ -49,18 +79,4 @@ public class EditServiceValidator {
 

 		return false;

 	}

-

-	private EObject getSemanticElement(Object object) {

-		EObject adapted = null;

-

-		if(object instanceof EObject) {

-			adapted = (EObject)object;

-

-		} else if(object instanceof IAdaptable) {

-			adapted = (EObject)((IAdaptable)object).getAdapter(EObject.class);

-

-		}

-

-		return adapted;

-	}

 }

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/SemanticUMLContentProvider.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/SemanticUMLContentProvider.java
index 86e33d1035b..e74fd039ccc 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/SemanticUMLContentProvider.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/SemanticUMLContentProvider.java
@@ -26,7 +26,11 @@ import org.eclipse.papyrus.uml.tools.utils.UMLUtil;
 import org.eclipse.uml2.uml.Element;

 import org.eclipse.uml2.uml.Stereotype;

 

-

+/**

+ * A semantic Hierarchic Content Provider for UML

+ * 

+ * @author Camille Letavernier

+ */

 public class SemanticUMLContentProvider extends SemanticEMFContentProvider {

 

 	public SemanticUMLContentProvider(EObject editedEObject, EStructuralFeature feature, EObject[] roots) {

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLContainerContentProvider.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLContainerContentProvider.java
index d4e97b6df7c..94715e21c1e 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLContainerContentProvider.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLContainerContentProvider.java
@@ -19,6 +19,13 @@ import org.eclipse.jface.viewers.Viewer;
 import org.eclipse.papyrus.infra.emf.utils.EMFHelper;

 

 

+/**

+ * A semantic Hierarchic Content Provider, which only browses the UML Containment tree.

+ * Standard references are ignored

+ * 

+ * @author Camille Letavernier

+ * 

+ */

 public class UMLContainerContentProvider extends SemanticUMLContentProvider {

 

 	protected EClass type;

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLLabelProvider.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLLabelProvider.java
index 692b68d7ed2..e3de00cf45d 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLLabelProvider.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/providers/UMLLabelProvider.java
@@ -32,6 +32,12 @@ import org.eclipse.uml2.uml.Type;
 import org.eclipse.uml2.uml.ValueSpecification;

 import org.eclipse.uml2.uml.util.UMLUtil;

 

+/**

+ * A global LabelProvider for UML

+ * 

+ * @author Camille Letavernier

+ * 

+ */

 public class UMLLabelProvider extends EMFLabelProvider implements ILabelProvider {

 

 	/** icon for metaclass */

diff --git a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/util/UMLProviderHelper.java b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/util/UMLProviderHelper.java
index 9b460306eab..e0bce2f435d 100644
--- a/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/util/UMLProviderHelper.java
+++ b/plugins/uml/tools/org.eclipse.papyrus.uml.tools/src/org/eclipse/papyrus/uml/tools/util/UMLProviderHelper.java
@@ -25,6 +25,11 @@ import org.eclipse.papyrus.infra.widgets.strategy.TreeBrowseStrategy;
 import org.eclipse.papyrus.uml.tools.providers.UMLContainmentBrowseStrategy;

 

 

+/**

+ * A Helper class for UML Content Providers

+ * 

+ * @author Camille Letavernier

+ */

 public class UMLProviderHelper {

 

 	/**