CursorJoiner

Kotlin |Java

public final class CursorJoiner
extends Object implements Iterator<CursorJoiner.Result>, Iterable<CursorJoiner.Result>

java.lang.Object
↳	android.database.CursorJoiner

Does a join on two cursors using the specified columns. The cursors must already be sorted on each of the specified columns in ascending order. This joiner only supports the case where the tuple of key column values is unique.

Typical usage:

 CursorJoiner joiner = new CursorJoiner(cursorA, keyColumnsofA, cursorB, keyColumnsofB);
 for (CursorJoiner.Result joinerResult : joiner) {
     switch (joinerResult) {
         case LEFT:
             // handle case where a row in cursorA is unique
             break;
         case RIGHT:
             // handle case where a row in cursorB is unique
             break;
         case BOTH:
             // handle case where a row with the same key is in both cursors
             break;
     }
 }

Summary

Public constructors
`CursorJoiner(Cursor cursorLeft, String[] columnNamesLeft, Cursor cursorRight, String[] columnNamesRight)` Initializes the CursorJoiner and resets the cursors to the first row.

Public methods
`boolean`	`hasNext()` Returns whether or not there are more rows to compare using next().
`Iterator<CursorJoiner.Result>`	`iterator()` Returns an iterator over elements of type `T`.
`CursorJoiner.Result`	`next()` Returns the comparison result of the next row from each cursor.
`void`	`remove()` Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.util.Iterator

`default void`	`forEachRemaining(Consumer<? super E> action)` Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
`abstract boolean`	`hasNext()` Returns `true` if the iteration has more elements.
`abstract CursorJoiner.Result`	`next()` Returns the next element in the iteration.
`default void`	`remove()` Removes from the underlying collection the last element returned by this iterator (optional operation).

From interface


        
          java.lang.Iterable

`default void`	`forEach(Consumer<? super T> action)` Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception.
`abstract Iterator<CursorJoiner.Result>`	`iterator()` Returns an iterator over elements of type `T`.
`default Spliterator<CursorJoiner.Result>`	`spliterator()` Creates a `Spliterator` over the elements described by this `Iterable`.

Public constructors

CursorJoiner

Added in API level 1

public CursorJoiner (Cursor cursorLeft, 
                String[] columnNamesLeft, 
                Cursor cursorRight, 
                String[] columnNamesRight)

Initializes the CursorJoiner and resets the cursors to the first row. The left and right column name arrays must have the same number of columns.

Parameters
`cursorLeft`	`Cursor`: The left cursor to compare
`columnNamesLeft`	`String`: The column names to compare from the left cursor
`cursorRight`	`Cursor`: The right cursor to compare
`columnNamesRight`	`String`: The column names to compare from the right cursor

Public methods

hasNext

Added in API level 1

public boolean hasNext ()

Returns whether or not there are more rows to compare using next().

Returns
`boolean`	true if there are more rows to compare

iterator

Added in API level 1

public Iterator<CursorJoiner.Result> iterator ()

Returns an iterator over elements of type T.

Returns
`Iterator<CursorJoiner.Result>`	an Iterator.

Added in API level 1

public CursorJoiner.Result next ()

Returns the comparison result of the next row from each cursor. If one cursor has no more rows but the other does then subsequent calls to this will indicate that the remaining rows are unique.

The caller must check that hasNext() returns true before calling this.

Once next() has been called the cursors specified in the result of the call to next() are guaranteed to point to the row that was indicated. Reading values from the cursor that was not indicated in the call to next() will result in undefined behavior.

Returns
`CursorJoiner.Result`	LEFT, if the row pointed to by the left cursor is unique, RIGHT if the row pointed to by the right cursor is unique, BOTH if the rows in both cursors are the same.

remove

Added in API level 1

public void remove ()

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next().

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.