From f5dc216fedcb1c5a7c8ae4ce1ef4db4c74924227 Mon Sep 17 00:00:00 2001
From: Alexander Diewald <diewald@fortiss.org>
Date: Mon, 3 Dec 2018 18:05:07 +0100
Subject: [PATCH] Code-Review: RED
* Red: Namings in CustomUndoRedoForSourceEditor, SourceEditorBase.
* GREEN: annotations.
Issue-Ref: 3582
Issue-Url: https://af3-developer.fortiss.org/issues/3582
Signed-off-by: Alexander Diewald <diewald@fortiss.org>
---
.../src/org/fortiss/tooling/base/ui/editor/.ratings | 4 ++--
.../ui/editor/CustomUndoRedoForSourceEditor.java | 1 +
.../tooling/base/ui/editor/SourceEditorBase.java | 2 ++
.../tooling/base/ui/editor/annotations/.ratings | 6 +++---
.../editor/annotations/AnnotationMarkerAccess.java | 12 ++++++++----
5 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/.ratings b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/.ratings
index bda9c63b8..b73ecb2b8 100644
--- a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/.ratings
+++ b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/.ratings
@@ -3,10 +3,10 @@ AllocationDiagramEditorBase.java fa544546f73eea1150d90b7257b0e6bce82c288c GREEN
CommonDiagramEditorBase.java 69994faea09eec342b8dfaa484ffc03b60978496 GREEN
ConstraintBasedProcessEditor.java 155a5a7ac41c668ae7ef978e8be13b83f5abd67d GREEN
ConstraintBasedProcessEditorHelper.java 11d48e8a2aecd48eea259a42ef1192c4b292a334 GREEN
-CustomUndoRedoForSourceEditor.java 30c68687962e1b8ff299cfdb938c4dad444edee0 YELLOW
+CustomUndoRedoForSourceEditor.java 3bf49cf31d99482ac4b102132450ab05faf7c22c RED
DiagramEditorBase.java 09663ce095074d1a8eef086284eea0a7776e0431 GREEN
DiagramKeyHandler.java cfd15ac8f9fc933739cef5e7039960e19826d1ce GREEN
FormsEditorBase.java 4046d340913d951340084ae7240d79f8e75cb8d4 GREEN
GEFEditorBase.java e668f596f45f07215994cbbd3929a9438331718f GREEN
-SourceEditorBase.java 66c3c1c0aea638912efeef6de7cc6502481b95ae YELLOW
+SourceEditorBase.java be8c65507ff54ad79d1a5b5a35de649a3f86deb9 RED
TreeViewerEditorBase.java 1c59689ff57c4f3cc180d85f13021fc03461ecb0 GREEN
diff --git a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/CustomUndoRedoForSourceEditor.java b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/CustomUndoRedoForSourceEditor.java
index 30c686879..3bf49cf31 100644
--- a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/CustomUndoRedoForSourceEditor.java
+++ b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/CustomUndoRedoForSourceEditor.java
@@ -29,6 +29,7 @@ import org.eclipse.swt.events.KeyListener;
*
* @author aravantinos
*/
+// TODO (AD): Please rename to SourceEditorUndoRedo (Easier to read).
public class CustomUndoRedoForSourceEditor implements KeyListener, ExtendedModifyListener {
/**
* Encapsulation of the Undo and Redo stack(s).
diff --git a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/SourceEditorBase.java b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/SourceEditorBase.java
index 66c3c1c0a..be8c65507 100644
--- a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/SourceEditorBase.java
+++ b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/SourceEditorBase.java
@@ -307,6 +307,8 @@ public abstract class SourceEditorBase<T extends EObject> extends EditorBase<T>
abstract protected String getStringRepresentation();
/** Update the string representation in the model element. */
+ // TODO(AD): Please reuse the the "setStringRepresentation": It is really a string representation
+ // of the source code model.
abstract protected void updateTheStringInTheModel(String s);
/** Displays the actual error in the editor. */
diff --git a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/.ratings b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/.ratings
index 2d30ce664..3c068c53b 100644
--- a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/.ratings
+++ b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/.ratings
@@ -1,3 +1,3 @@
-AnnotationHover.java 02988c3a040a394afb427af10c965d9f82b9a01d YELLOW
-AnnotationMarkerAccess.java d6435f60fb60e8f62f2d08287a0a9d59ed2e8ae7 YELLOW
-ErrorAnnotation.java 3e05aaeb93ca19bb99aed312427752c2c3f1959f YELLOW
+AnnotationHover.java 02988c3a040a394afb427af10c965d9f82b9a01d GREEN
+AnnotationMarkerAccess.java 1977a4093f76d42638a560ed305f1d2cc3dedc4e GREEN
+ErrorAnnotation.java 3e05aaeb93ca19bb99aed312427752c2c3f1959f GREEN
diff --git a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/AnnotationMarkerAccess.java b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/AnnotationMarkerAccess.java
index d6435f60f..1977a4093 100644
--- a/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/AnnotationMarkerAccess.java
+++ b/org.fortiss.tooling.base.ui/src/org/fortiss/tooling/base/ui/editor/annotations/AnnotationMarkerAccess.java
@@ -52,8 +52,9 @@ public class AnnotationMarkerAccess implements IAnnotationAccess, IAnnotationAcc
/** {@inheritDoc} */
@Override
public String getTypeLabel(Annotation annotation) {
- if(annotation instanceof ErrorAnnotation)
+ if(annotation instanceof ErrorAnnotation) {
return "Errors";
+ }
return null;
}
@@ -61,8 +62,9 @@ public class AnnotationMarkerAccess implements IAnnotationAccess, IAnnotationAcc
/** {@inheritDoc} */
@Override
public int getLayer(Annotation annotation) {
- if(annotation instanceof ErrorAnnotation)
+ if(annotation instanceof ErrorAnnotation) {
return ((ErrorAnnotation)annotation).getLayer();
+ }
return 0;
}
@@ -77,8 +79,9 @@ public class AnnotationMarkerAccess implements IAnnotationAccess, IAnnotationAcc
/** {@inheritDoc} */
@Override
public boolean isPaintable(Annotation annotation) {
- if(annotation instanceof ErrorAnnotation)
+ if(annotation instanceof ErrorAnnotation) {
return ((ErrorAnnotation)annotation).getImage() != null;
+ }
return false;
}
@@ -86,8 +89,9 @@ public class AnnotationMarkerAccess implements IAnnotationAccess, IAnnotationAcc
/** {@inheritDoc} */
@Override
public boolean isSubtype(Object annotationType, Object potentialSupertype) {
- if(annotationType.equals(potentialSupertype))
+ if(annotationType.equals(potentialSupertype)) {
return true;
+ }
return false;
}
--
GitLab