[accumulo] branch main updated: Fix #1889 Clarify IteratorEnvironment is non-null

[ctubbsii]

This is an automated email from the ASF dual-hosted git repository.

ctubbsii pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/main by this push:
     new f7db175  Fix #1889 Clarify IteratorEnvironment is non-null
     new 27ed66b  Merge branch '1.10' into main
f7db175 is described below

commit f7db1750938a748b7a9c024ea2c52276c8c54894
Author: Christopher Tubbs <ctubb...@apache.org>
AuthorDate: Mon Feb 1 15:33:32 2021 -0500

    Fix #1889 Clarify IteratorEnvironment is non-null
    
    Update javadoc for SortedKeyValueIterator methods that receive an
    IteratorEnvironment to mention that the environment is provided by
    Accumulo itself and is expected to be non-null.
---
 .../org/apache/accumulo/core/iterators/SortedKeyValueIterator.java  | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git 
a/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
 
b/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
index 256cd5d..81ca628 100644
--- 
a/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
+++ 
b/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
@@ -40,7 +40,8 @@ public interface SortedKeyValueIterator<K extends 
WritableComparable<?>,V extend
    * @param options
    *          <code>Map</code> map of string option names to option values.
    * @param env
-   *          <code>IteratorEnvironment</code> environment in which iterator 
is being run.
+   *          <code>IteratorEnvironment</code> environment in which iterator 
is being run, provided
+   *          by Accumulo itself and is expected to be non-null.
    * @throws IOException
    *           unused.
    * @exception IllegalArgumentException
@@ -159,7 +160,8 @@ public interface SortedKeyValueIterator<K extends 
WritableComparable<?>,V extend
    * either on the original or the copy. A proper implementation would call 
deepCopy on the source.
    *
    * @param env
-   *          <code>IteratorEnvironment</code> environment in which iterator 
is being run.
+   *          <code>IteratorEnvironment</code> environment in which iterator 
is being run, provided
+   *          by Accumulo itself and is expected to be non-null.
    * @return <code>SortedKeyValueIterator</code> a copy of this iterator (with 
the same source and
    *         settings).
    * @exception UnsupportedOperationException