Deprecate Cursor.open().

This method should not be called from code consuming the Cursor.

See: #1575
Original Pull Request: #2014
This commit is contained in:
Mark Paluch
2021-03-23 11:49:17 +01:00
committed by Christoph Strobl
parent 0061d6c7af
commit b0dd3cda6c

View File

@@ -43,10 +43,13 @@ public interface Cursor<T> extends BoundedIterator<T>, CloseableIterator<T> {
boolean isClosed();
/**
* Opens cursor and returns itself.
* Opens cursor and returns itself. This method is intended to be called by components constructing a {@link Cursor}
* and should not be called externally.
*
* @return the opened cursor.
* @deprecated to be removed from the interface in the next major version.
*/
@Deprecated
Cursor<T> open();
/**