Mark improvements with TODO instead of FIXME 78/14378/1
authorMarek Gradzki <mgradzki@cisco.com>
Tue, 21 Aug 2018 07:01:37 +0000 (09:01 +0200)
committerMarek Gradzki <mgradzki@cisco.com>
Tue, 21 Aug 2018 07:01:39 +0000 (09:01 +0200)
Sonar reports FIXMES as issues with higher priority as TODOs.
FIXMEs should only be used for known bugs,
not for improvements.

Also include JIRA issue ID in the TODO message.

Change-Id: I47461d948421ff17532f17ecec3ddae84239511f
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
infra/data-impl/src/main/java/io/fd/honeycomb/data/impl/ModifiableDataTreeManager.java
infra/data-impl/src/main/java/io/fd/honeycomb/data/impl/Modification.java
infra/data-impl/src/main/java/io/fd/honeycomb/data/impl/PersistingDataTreeAdapter.java
infra/data-impl/src/test/java/io/fd/honeycomb/data/impl/ModifiableDataTreeDelegatorTest.java

index acaa6e5..4fa517c 100644 (file)
@@ -85,7 +85,7 @@ public class ModifiableDataTreeManager implements ModifiableDataManager {
         @Override
         public CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(
                 @Nonnull final YangInstanceIdentifier path) {
-            // FIXME switch to java.util.Optional when rest of ODL infra does
+            // TODO(HONEYCOMB-192): switch to java.util.Optional when rest of ODL infra does
             final Optional<NormalizedNode<?, ?>> node = Optional.fromNullable(modification.readNode(path).orElse(null));
             if (LOG.isTraceEnabled() && node.isPresent()) {
                 LOG.trace("ConfigSnapshot.read: {}", node.get());
index 45a207c..b95fc98 100644 (file)
@@ -89,12 +89,12 @@ final class Modification {
     }
 
     com.google.common.base.Optional<NormalizedNode<?, ?>> getDataBefore() {
-        // FIXME switch to java.util.Optional when rest of ODL infra does
+        // TODO(HONEYCOMB-192): switch to java.util.Optional when rest of ODL infra does
         return com.google.common.base.Optional.fromNullable(dataCandidate.getDataBefore().orElse(null));
     }
 
     com.google.common.base.Optional<NormalizedNode<?, ?>> getDataAfter() {
-        // FIXME switch to java.util.Optional when rest of ODL infra does
+        // TODO(HONEYCOMB-192): switch to java.util.Optional when rest of ODL infra does
         return com.google.common.base.Optional.fromNullable(dataCandidate.getDataAfter().orElse(null));
     }
 
index d779e62..df6f199 100644 (file)
@@ -89,7 +89,7 @@ public class PersistingDataTreeAdapter implements DataTree {
         delegateDependency.commit(dataTreeCandidate);
         LOG.debug("Delegate commit successful. Persisting data");
 
-        // FIXME doing full read and full write might not be the fastest way of persisting data here
+        // TODO(HONEYCOMB-163): doing full read and full write might not be the fastest way of persisting data here
         final DataTreeSnapshot dataTreeSnapshot = delegateDependency.takeSnapshot();
 
         // TODO this can be handled in background by a dedicated thread + a limited blocking queue
index f40e0e6..b1e60c4 100644 (file)
@@ -64,7 +64,6 @@ public class ModifiableDataTreeDelegatorTest extends ModifiableDataTreeDelegator
         assertEquals(normalizedNodeOptional, normalizedNodeOptional2);
         assertTrue(normalizedNodeOptional.isPresent());
         assertEquals(topContainer, normalizedNodeOptional.get());
-        // FIXMe use toJavaUtil everywhere
         assertEquals(dataTree.takeSnapshot().readNode(TOP_CONTAINER_ID), Optional.toJavaUtil(normalizedNodeOptional));
     }