svn commit: r1879328 - /jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/linkedList/NodeStateEntryList.java

[thomasm]

Author: thomasm
Date: Mon Jun 29 12:46:22 2020
New Revision: 1879328

URL: http://svn.apache.org/viewvc?rev=1879328&view=rev
Log:
OAK-9121 Oak-run indexing: add a cache to flatfile/PersistedLinkedList (javadoc)

Modified:
    
jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/linkedList/NodeStateEntryList.java

Modified: 
jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/linkedList/NodeStateEntryList.java
URL: 
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/linkedList/NodeStateEntryList.java?rev=1879328&r1=1879327&r2=1879328&view=diff
==============================================================================
--- 
jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/linkedList/NodeStateEntryList.java
 (original)
+++ 
jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/linkedList/NodeStateEntryList.java
 Mon Jun 29 12:46:22 2020
@@ -26,13 +26,14 @@ import org.jetbrains.annotations.NotNull
 public interface NodeStateEntryList {
 
     /**
-     * Add {@code item} at the tail of the list
+     * Add an item at the tail of the list.
      */
     public void add(@NotNull NodeStateEntry item);
 
     /**
-     * Remove the first item from the list
-     * @return {@code NodeStateEntry} data in the removed item
+     * Remove the first item from the list.
+     *
+     * @return the removed item
      */
     public NodeStateEntry remove();
 
@@ -41,7 +42,7 @@ public interface NodeStateEntryList {
     public int size();
 
     /**
-     * @return {@link NodeIterator} object which would iterate the whole list
+     * Get an iterator to iterate over the whole list
      */
     public Iterator<NodeStateEntry> iterator();