From 93c4f10e83673432ae7936e8375530a5aca26e3d Mon Sep 17 00:00:00 2001
From: Vincent Aravantinos <aravantinos@fortiss.org>
Date: Wed, 8 Nov 2017 15:15:05 +0000
Subject: [PATCH] YELLOW
---
.../kernel/ui/util/ConstraintsUIUtils.java | 45 +++++--------------
1 file changed, 10 insertions(+), 35 deletions(-)
diff --git a/org.fortiss.tooling.kernel.ui/trunk/src/org/fortiss/tooling/kernel/ui/util/ConstraintsUIUtils.java b/org.fortiss.tooling.kernel.ui/trunk/src/org/fortiss/tooling/kernel/ui/util/ConstraintsUIUtils.java
index 4ccb5286b..273bbe298 100644
--- a/org.fortiss.tooling.kernel.ui/trunk/src/org/fortiss/tooling/kernel/ui/util/ConstraintsUIUtils.java
+++ b/org.fortiss.tooling.kernel.ui/trunk/src/org/fortiss/tooling/kernel/ui/util/ConstraintsUIUtils.java
@@ -54,9 +54,8 @@ import org.fortiss.tooling.kernel.utils.EcoreUtils;
* @author aravantinos
* @author $Author$
* @version $Rev$
- * @ConQAT.Rating YELLOW Hash: 97453A8CA6928F43F260FB918B4C1AA4
+ * @ConQAT.Rating YELLOW Hash: B7B5322692639BE0093B6969ADC18BC6
*/
-// TODO (FH): remove @params or document
public class ConstraintsUIUtils {
/** Gathers some statuses by verification status. */
@@ -83,10 +82,7 @@ public class ConstraintsUIUtils {
}
}
- /**
- * @param constrained
- * @return {@link ClassifiedStatuses} corresponding to <code>constrained</code>.
- */
+ /** Returns {@link ClassifiedStatuses} corresponding to <code>constrained</code>. */
public static ClassifiedStatuses getClassifiedStatuses(IConstrained constrained) {
ClassifiedStatuses res = new ClassifiedStatuses();
for(ConstraintInstance constraint : constrained.getConstraintInstances()) {
@@ -108,10 +104,7 @@ public class ConstraintsUIUtils {
return res;
}
- /**
- * @param c
- * @return {@link ESeverity} corresponding to the status of the constraint <code>c</code>
- */
+ /** Returns {@link ESeverity} corresponding to the status of the constraint <code>c</code> */
public static ESeverity getConstraintSeverity(ConstraintInstance c) {
IConstraintInstanceStatus status = IConstraintUIService.getInstance().getStatus(c);
if(IConstraintUIService.getInstance().shallDisplayAsWarning(c)) {
@@ -132,10 +125,7 @@ public class ConstraintsUIUtils {
}
}
- /**
- * @param c
- * @return Severity corresponding to the status of the constraints of <code>c</code>.
- */
+ /** Returns severity corresponding to the status of the constraints of <code>c</code>. */
public static ESeverity getSeverity(IConstrained c) {
try {
return c.getConstraintInstances().stream().map(cstr -> getConstraintSeverity(cstr))
@@ -146,12 +136,8 @@ public class ConstraintsUIUtils {
}
/**
- * @param sev
- * @param modelElement
- * @return the maximum severity between <code>sev</code> and the severity resulting of possibly
- * unsatisfied constraints on <code>modelElement</code>.
- *
- * Note: if, later on, {@link IConstraintViolation}
+ * Returns the maximum severity between <code>sev</code> and the severity resulting of possibly
+ * unsatisfied constraints on <code>modelElement</code>.
*/
public static ESeverity augmentSeverityWithConstraintSeverity(ESeverity sev,
EObject modelElement) {
@@ -210,9 +196,7 @@ public class ConstraintsUIUtils {
}
}
- /**
- * @return Standard text describing the status of <code>c</code>.
- */
+ /** Returns a standard text describing the status of <code>c</code>. */
public static String getText(ConstraintInstance c) {
if(c == null) {
return "";
@@ -231,10 +215,7 @@ public class ConstraintsUIUtils {
return mainMsg;
}
- /**
- * @param c
- * @return Standard "hint" indicating possible action on the status of <code>c</code>.
- */
+ /** Returns a standard "hint" indicating possible action on the status of <code>c</code>. */
public static String getHint(ConstraintInstance c) {
if(c == null) {
return "";
@@ -248,10 +229,7 @@ public class ConstraintsUIUtils {
return "";
}
- /**
- * @param c
- * @return Standard colour corresponding to the status of <code>c</code>.
- */
+ /** Returns a standard color corresponding to the status of <code>c</code>. */
public static Color getColor(ConstraintInstance c) {
Display display = Display.getCurrent();
if(c == null) {
@@ -313,10 +291,7 @@ public class ConstraintsUIUtils {
}
}
- /**
- * @param constraint
- * @return <code>true</code> if <code>constraint</code> is active.
- */
+ /** Returns <code>true</code> iff <code>constraint</code> is active. */
public static boolean isConstraintActive(ConstraintInstance constraint) {
return IConstraintUIService.getInstance().getStatus(constraint) != null;
}
--
GitLab