From 065e66cc9b11a4c0afcf625f2cf98b71353a95bd Mon Sep 17 00:00:00 2001
From: Florian Hoelzl <hoelzl@fortiss.org>
Date: Thu, 1 Dec 2011 15:44:37 +0000
Subject: [PATCH] org.fortiss.tooling.kernel YELLOW refs 311
---
.../extension/IConnectionCompositor.java | 24 +++++++++----------
.../kernel/extension/IElementCompositor.java | 17 ++++++++-----
.../base/ConstraintViolationBase.java | 10 ++++----
.../kernel/internal/CommandStackService.java | 2 +-
.../internal/ConnectionCompositorService.java | 2 +-
.../kernel/internal/DummyTopLevelElement.java | 2 +-
.../kernel/internal/PersistencyService.java | 2 +-
.../EclipseResourceStorageProvider.java | 2 +-
.../storage/eclipse/ModelContext.java | 3 +--
.../kernel/service/ICommandStackService.java | 5 ++--
.../service/IConnectionCompositorService.java | 2 +-
.../kernel/service/IPersistencyService.java | 2 +-
12 files changed, 39 insertions(+), 34 deletions(-)
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IConnectionCompositor.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IConnectionCompositor.java
index 7d408bf26..59d672213 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IConnectionCompositor.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IConnectionCompositor.java
@@ -48,7 +48,7 @@ import org.fortiss.tooling.kernel.service.base.IEObjectAware2;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: FB4A39FA785FA53441998CE212CA9017
+ * @ConQAT.Rating YELLOW Hash: 87CA722778F0E929E19A904A54831E27
*/
public interface IConnectionCompositor<P extends EObject, S extends EObject, T extends EObject>
extends IEObjectAware2<S, T> {
@@ -62,10 +62,10 @@ public interface IConnectionCompositor<P extends EObject, S extends EObject, T e
/**
* Actually connects the given source and target. This will only be called
- * if
+ * by the service if
* {@link #canConnect(EObject, EObject, EObject, IConnectionCompositionContext)}
- * returned true. This method returns a boolean, since user-interaction
- * during the connect might cancel the connect.
+ * returned <code>true</code>. This method returns a boolean, since
+ * user-interaction during the connect might cancel the connect.
*
* @param source
* the source of the connection.
@@ -81,7 +81,7 @@ public interface IConnectionCompositor<P extends EObject, S extends EObject, T e
/**
* Returns whether the given connection can be altered to connect the given
- * source and target.Additional information can be included in the context,
+ * source and target. Additional information can be included in the context,
* which also may be null.
*/
boolean canReconnect(EObject connection, S source, T target,
@@ -89,23 +89,23 @@ public interface IConnectionCompositor<P extends EObject, S extends EObject, T e
/**
* Actually reconnects the given source and target. This will only be called
- * if
+ * by the service if
* {@link #canReconnect(EObject, EObject, EObject, IConnectionCompositionContext)
- * )} returned true.Additional information can be included in the context,
- * which also may be null.
+ * )} returned <code>true</code>. Additional information can be included in
+ * the context, which also may be null.
*/
boolean reconnect(EObject connection, S source, T target,
IConnectionCompositionContext context);
/**
- * Returns whether a connection between the source and the target can be
- * removed.
+ * Returns whether the connection can be disconnected by the compositor.
*/
boolean canDisconnect(EObject connection);
/**
- * Actually disconnects the given source and target. This will only be
- * called if {@link #canDisconnect(EObject)} returned true.
+ * Actually disconnects the given connection. This will only be called by
+ * the service if {@link #canDisconnect(EObject)} returned <code>true</code>
+ * .
*/
boolean disconnect(EObject connection);
}
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IElementCompositor.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IElementCompositor.java
index 32b64a7d4..98d410cf8 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IElementCompositor.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/IElementCompositor.java
@@ -39,7 +39,7 @@ import org.fortiss.tooling.kernel.service.base.IEObjectAware;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 6B9FED9C612B7E487341ACB7AE06C1B7
+ * @ConQAT.Rating YELLOW Hash: 81AC15BB6A2702199A7E45761256CDE4
*/
public interface IElementCompositor<C extends EObject> extends IEObjectAware<C> {
/**
@@ -61,22 +61,27 @@ public interface IElementCompositor<C extends EObject> extends IEObjectAware<C>
/**
* Asks the compositor to insert the contained object into the container.
* The contained object may be modified (i.e. renamed, etc.) if necessary.
- * This method returns a boolean, since user-interaction during compose
- * might cancel the command.
+ * This method is only called by the service if
+ * {@link #canCompose(EObject, EObject, IElementCompositionContext)} or
+ * {@link #canComposePrototype(Prototype)} (depending on the actual
+ * situation) returned <code>true</code>. This method returns a boolean,
+ * since user-interaction during compose might cancel the command.
*/
boolean compose(C container, EObject contained,
IElementCompositionContext context);
/**
* Returns whether the given contained element may be removed from its
- * parent container element.
+ * parent container element by this compositor.
*/
boolean canDecompose(EObject contained);
/**
* Asks the compositor to remove the contained object from its container.
- * This method returns a boolean, since user-interaction during compose
- * might cancel the command.
+ * This method is only called by the service if
+ * {@link #canDecompose(EObject)} returned <code>true</code>. This method
+ * returns a boolean, since user-interaction during compose might cancel the
+ * command.
*/
boolean decompose(EObject contained);
}
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/base/ConstraintViolationBase.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/base/ConstraintViolationBase.java
index 553606449..0ff80e8af 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/base/ConstraintViolationBase.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/extension/base/ConstraintViolationBase.java
@@ -18,18 +18,18 @@ $Id$
package org.fortiss.tooling.kernel.extension.base;
import org.eclipse.emf.ecore.EObject;
+import org.fortiss.tooling.kernel.extension.IConstraintChecker;
import org.fortiss.tooling.kernel.extension.data.IConstraintViolation;
/**
- * Base implementation for model element constraint checkers.
- *
- * TODO: the above comment is not aligned with the name of the class - should we
- * use a better docu?
+ * Base implementation for {@link IConstraintViolation} produced by model
+ * element {@link IConstraintChecker}s. It stores the violating model element
+ * and returns <code>null</code> as quick fix handler.
*
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating RED Hash: 8D1F169799F4A0110E68D25482929E80
+ * @ConQAT.Rating YELLOW Hash: 5968B8078503BFB90E32F041A5BD160C
*/
public abstract class ConstraintViolationBase<T extends EObject> implements
IConstraintViolation<T> {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/CommandStackService.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/CommandStackService.java
index 2b01546bd..ad8f8262f 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/CommandStackService.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/CommandStackService.java
@@ -33,7 +33,7 @@ import org.fortiss.tooling.kernel.utils.LoggingUtils;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 4EC48FE57128162812231DF1915E0DFA
+ * @ConQAT.Rating YELLOW Hash: 9419FA04EC4ABCDEE7575A87CB832C5F
*/
public class CommandStackService implements ICommandStackService {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/ConnectionCompositorService.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/ConnectionCompositorService.java
index 501a05017..360bd6339 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/ConnectionCompositorService.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/ConnectionCompositorService.java
@@ -32,7 +32,7 @@ import org.fortiss.tooling.kernel.service.base.EObjectAware2ServiceBase;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 8EA9DA35FC5ABE4E59208DA0DA509CE0
+ * @ConQAT.Rating YELLOW Hash: 74FB384A7234346FD45E4289FE0707D6
*/
public class ConnectionCompositorService
extends
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/DummyTopLevelElement.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/DummyTopLevelElement.java
index 8444728e1..171a3652f 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/DummyTopLevelElement.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/DummyTopLevelElement.java
@@ -32,7 +32,7 @@ import org.fortiss.tooling.kernel.service.IPersistencyService;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 5F332ABA912DD7731BDFD020F2AB2CA4
+ * @ConQAT.Rating YELLOW Hash: 445763C2405388E4F17575455A869281
*/
final class DummyTopLevelElement implements ITopLevelElement {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/PersistencyService.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/PersistencyService.java
index aabcd6d71..8595ec5a8 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/PersistencyService.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/PersistencyService.java
@@ -49,7 +49,7 @@ import org.osgi.framework.Bundle;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 9B4C1045CBB864223484897D94848F95
+ * @ConQAT.Rating YELLOW Hash: A05DB638DEDC3398170FC193467F9DA6
*/
public class PersistencyService implements IPersistencyService {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/EclipseResourceStorageProvider.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/EclipseResourceStorageProvider.java
index 999165257..ec0e255ba 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/EclipseResourceStorageProvider.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/EclipseResourceStorageProvider.java
@@ -56,7 +56,7 @@ import org.osgi.framework.Bundle;
* @author hoelzlf
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 381A7724942C4F7BE3BFFCC64F1A7C91
+ * @ConQAT.Rating YELLOW Hash: 9AB0823B246FC76AE1593AA9B6888BF5
*/
public class EclipseResourceStorageProvider implements
IEclipseResourceStorageService, IResourceChangeListener,
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/ModelContext.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/ModelContext.java
index 7b609da21..f84a23f6a 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/ModelContext.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/internal/storage/eclipse/ModelContext.java
@@ -54,7 +54,7 @@ import org.fortiss.tooling.kernel.utils.LoggingUtils;
* @author hummel
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: AAAEB5802D74F212F47C25AD613B97CF
+ * @ConQAT.Rating YELLOW Hash: BD4970391280C8C290235EB9DE2C742D
*/
class ModelContext implements ITopLevelElement, CommandStackListener {
@@ -211,7 +211,6 @@ class ModelContext implements ITopLevelElement, CommandStackListener {
public void destroy() {
// discard changes
((BasicCommandStack) editingDomain.getCommandStack()).saveIsDone();
- // TODO (FH): close editors
transactionalCommandStack.removeCommandStackListener(this);
}
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/ICommandStackService.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/ICommandStackService.java
index 350d3f39d..a3c4aba91 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/ICommandStackService.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/ICommandStackService.java
@@ -28,12 +28,13 @@ import org.fortiss.tooling.kernel.internal.CommandStackService;
* domain. It provides a Undo/Redo mechanism and allows {@link Runnable}s to be
* executed, which need to modify the model. It also provides a view on the
* underlying persistency mechanism by providing a dirty state and a save
- * method.
+ * method. Changes to the model are communicated to listeners registered with
+ * the model's command stack.
*
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 0673CEE9D531862ED2BEB34AFCB77AED
+ * @ConQAT.Rating YELLOW Hash: 1594F25FBD1F084A4B57CA2ABAEF7851
*/
public interface ICommandStackService {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IConnectionCompositorService.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IConnectionCompositorService.java
index 73104b17e..f2f77eb27 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IConnectionCompositorService.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IConnectionCompositorService.java
@@ -35,7 +35,7 @@ import org.fortiss.tooling.kernel.internal.ConnectionCompositorService;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: C946551167EBAC9E9C1296FD20E198E1
+ * @ConQAT.Rating YELLOW Hash: D14B9C599496C416C4DD21EF7D9F875C
*/
public interface IConnectionCompositorService {
diff --git a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IPersistencyService.java b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IPersistencyService.java
index 8cc646e16..60cf2233b 100644
--- a/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IPersistencyService.java
+++ b/org.fortiss.tooling.kernel/trunk/src/org/fortiss/tooling/kernel/service/IPersistencyService.java
@@ -41,7 +41,7 @@ import org.fortiss.tooling.kernel.service.listener.IPersistencyServiceListener;
* @author hoelzl
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating GREEN Hash: 2FFF20C4EEB1C3B252E0925640300886
+ * @ConQAT.Rating YELLOW Hash: A4BFEC90B06C148D6020E63708A3D6FF
*/
public interface IPersistencyService {
--
GitLab