commit 6b2ec28fbaf910bbc62bde802061959e5d4da8ad
author Yuta HIGUCHI <y-higuchi@ak.jp.nec.com> Fri Nov 03 21:08:38 2017 -0700
committer Jordan Halterman <jordan@opennetworking.org> Mon Nov 06 01:30:20 2017 +0000
tree 0e7a0565e268b2149c6bb9c9b33e613f35f7175e
parent 796a78d959a34b7b3c1f4c8c2311ac01d9b9d44b

improve DocumentTree related doc & log

Change-Id: I85294811d9647ace85e5cd70fbca7fce020e3ee1

core/api/src/main/java/org/onosproject/store/service/DocumentTreeEvent.java

diff --git a/core/api/src/main/java/org/onosproject/store/service/DocumentTreeEvent.java b/core/api/src/main/java/org/onosproject/store/service/DocumentTreeEvent.java
index 81b28ac..6e628c0 100644
--- a/core/api/src/main/java/org/onosproject/store/service/DocumentTreeEvent.java
+++ b/core/api/src/main/java/org/onosproject/store/service/DocumentTreeEvent.java
@@ -45,7 +45,19 @@
          * Signifies an existing node being deleted.
          */
         DELETED,
+        /**
+         * Signifies beginning of Transaction events.
+         *
+         * Note: {@link DocumentTreeEvent#path()} will contain
+         * single element representing TransactionId.
+         */
         TRANSACTION_START,
+        /**
+         * Signifies end of Transaction events.
+         *
+         * Note: {@link DocumentTreeEvent#path()} will contain
+         * single element representing TransactionId.
+         */
         TRANSACTION_END
     }
 
@@ -79,6 +91,7 @@
         this.newValue = newValue;
         this.oldValue = oldValue;
     }
+
     /**
      * Constructs a new {@code DocumentTreeEvent}.
      *

core/store/primitives/src/main/java/org/onosproject/store/primitives/resources/impl/DefaultDocumentTree.java

diff --git a/core/store/primitives/src/main/java/org/onosproject/store/primitives/resources/impl/DefaultDocumentTree.java b/core/store/primitives/src/main/java/org/onosproject/store/primitives/resources/impl/DefaultDocumentTree.java
index 31bd20c..82098d3 100644
--- a/core/store/primitives/src/main/java/org/onosproject/store/primitives/resources/impl/DefaultDocumentTree.java
+++ b/core/store/primitives/src/main/java/org/onosproject/store/primitives/resources/impl/DefaultDocumentTree.java
@@ -16,6 +16,8 @@
 
 package org.onosproject.store.primitives.resources.impl;
 
+import static com.google.common.base.Preconditions.checkArgument;
+
 import java.util.Iterator;
 import java.util.Map;
 import java.util.Objects;
@@ -30,7 +32,6 @@
 import org.onosproject.store.service.Ordering;
 import org.onosproject.store.service.Versioned;
 
-import com.google.common.base.Preconditions;
 import com.google.common.base.Supplier;
 import com.google.common.collect.Maps;
 
@@ -48,11 +49,11 @@
     public DefaultDocumentTree() {
         AtomicLong versionCounter = new AtomicLong(0);
         versionSupplier = versionCounter::incrementAndGet;
-        root = new DefaultDocumentTreeNode<V>(ROOT_PATH, null, versionSupplier.get(), Ordering.NATURAL, null);
+        root = new DefaultDocumentTreeNode<>(ROOT_PATH, null, versionSupplier.get(), Ordering.NATURAL, null);
     }
 
     public DefaultDocumentTree(Supplier<Long> versionSupplier, Ordering ordering) {
-        root = new DefaultDocumentTreeNode<V>(ROOT_PATH, null, versionSupplier.get(), ordering, null);
+        root = new DefaultDocumentTreeNode<>(ROOT_PATH, null, versionSupplier.get(), ordering, null);
         this.versionSupplier = versionSupplier;
     }
 
@@ -188,7 +189,7 @@
     private DefaultDocumentTreeNode<V> getNode(DocumentPath path) {
         Iterator<String> pathElements = path.pathElements().iterator();
         DefaultDocumentTreeNode<V> currentNode = root;
-        Preconditions.checkState("root".equals(pathElements.next()), "Path should start with root");
+        checkArgument("root".equals(pathElements.next()), "Path should start with root: %s", path);
         while (pathElements.hasNext() &&  currentNode != null) {
             currentNode = (DefaultDocumentTreeNode<V>) currentNode.child(pathElements.next());
         }