com.rethinkdb.net

Class Result<T>

java.lang.Object

com.rethinkdb.net.Result<T>

Type Parameters:

T - the type of the result.

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<T>, java.util.Iterator<T>

public class Result<T>
extends java.lang.Object
implements java.util.Iterator<T>, java.lang.Iterable<T>, java.io.Closeable

A ReQL query result.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Result.FetchMode The fetch mode to use on partial sequences.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.CompletableFuture<java.lang.Boolean>	completed
protected Connection	connection
protected Result.FetchMode	fetchMode
protected Internals.FormatOptions	fmt
protected Query	query
protected java.util.concurrent.BlockingQueue<java.lang.Object>	rawQueue
protected Response	sourceResponse
protected com.fasterxml.jackson.core.type.TypeReference<T>	typeRef
protected boolean	unwrapLists

Constructor Summary

Constructors

Constructor and Description
Result(Connection connection, Query query, Response sourceResponse, Result.FetchMode fetchMode, boolean unwrapLists, com.fasterxml.jackson.core.type.TypeReference<T> typeRef)

Method Summary

Modifier and Type	Method and Description
int	bufferedCount() Gets the number of objects buffered and readily available.
void	close() Closes this Result.
<R,A> R	collect(@NotNull java.util.stream.Collector<? super T,A,R> collector) Collect all remaining results using the provided Collector, fetching from the server if necessary, and closes the Result. WARNING: If isFeed() is true, this may never return.
long	connectionToken() Gets the connection token of this result.
protected Response	currentResponse()
protected int	emitData(Response res)
T	first() Returns the first object and closes the Result, discarding all other results.
void	forEach(java.util.function.Consumer<? super T> action)
void	forEachRemaining(java.util.function.Consumer<? super T> action)
protected void	handleFirstResponse() Function called on the first response.
boolean	hasNext()
boolean	isFeed() Gets if this Result is a feed.
@NotNull java.util.Iterator<T>	iterator()
protected void	maybeContinue()
T	next()
T	next(long timeout, java.util.concurrent.TimeUnit unit) Returns the next element in the iteration, with a defined timeout.
protected void	onConnectionClosed()
@NotNull Result<T>	overrideFetchMode(Result.FetchMode fetchMode) Overrides the fetch mode for this Result.
@NotNull java.util.stream.Stream<T>	parallelStream() Creates a new parallel Stream from the results, which closes this Result on completion.
@Nullable Profile	profile() Gets the current's response Profile, if any.
@NotNull ResponseType	responseType() Returns the current responses' type.
T	single() Returns the first object and closes the Result, discarding all other results.
@NotNull java.util.stream.Stream<T>	stream() Creates a new sequential Stream from the results, which closes this Result on completion.
protected void	throwOnCompleted()
@NotNull java.util.List<T>	toList() Collect all remaining results to a list, fetching from the server if necessary, and closes the Result. WARNING: If isFeed() is true, this may never return.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

remove

Methods inherited from interface java.lang.Iterable

spliterator

Field Detail

connection

protected final Connection connection

query

protected final Query query

sourceResponse

protected final Response sourceResponse

typeRef

protected final com.fasterxml.jackson.core.type.TypeReference<T> typeRef

fmt

protected final Internals.FormatOptions fmt

unwrapLists

protected final boolean unwrapLists

fetchMode

protected Result.FetchMode fetchMode

rawQueue

protected final java.util.concurrent.BlockingQueue<java.lang.Object> rawQueue

completed

protected final java.util.concurrent.CompletableFuture<java.lang.Boolean> completed

Constructor Detail

Result

public Result(Connection connection,
              Query query,
              Response sourceResponse,
              Result.FetchMode fetchMode,
              boolean unwrapLists,
              com.fasterxml.jackson.core.type.TypeReference<T> typeRef)

Method Detail

connectionToken

public long connectionToken()

Gets the connection token of this result.

Returns:

the connection token.

bufferedCount

public int bufferedCount()

Gets the number of objects buffered and readily available.

Returns:

the buffered objects queue size.

isFeed

public boolean isFeed()

Gets if this Result is a feed. Feeds may never end at all.

Returns:

true if this Result is a feed.

close

public void close()

Closes this Result.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

toList

@NotNull
public @NotNull java.util.List<T> toList()

Collect all remaining results to a list, fetching from the server if necessary, and closes the Result.

WARNING: If isFeed() is true, this may never return. This method changes the fetchMode of this Result to Result.FetchMode.AGGRESSIVE to complete this as fast as possible.

Returns:

the list

collect

public <R,A> R collect(@NotNull
                       @NotNull java.util.stream.Collector<? super T,A,R> collector)

Collect all remaining results using the provided Collector, fetching from the server if necessary, and closes the Result.

WARNING: If isFeed() is true, this may never return. This method changes the fetchMode of this Result to Result.FetchMode.AGGRESSIVE to complete this as fast as possible.

Type Parameters:

A - the mutable accumulation type of the reduction operation (often hidden as an implementation detail)

R - the result type of the reduction operation

Parameters:

collector - the collector

Returns:

the final result

stream

@NotNull
public @NotNull java.util.stream.Stream<T> stream()

Creates a new sequential Stream from the results, which closes this Result on completion.

WARNING: If isFeed() is true, this stream is possibly infinite. This method changes the fetchMode of this Result to Result.FetchMode.AGGRESSIVE to complete this as fast as possible.

Returns:

the newly created stream.

parallelStream

@NotNull
public @NotNull java.util.stream.Stream<T> parallelStream()

Creates a new parallel Stream from the results, which closes this Result on completion.

WARNING: If isFeed() is true, this stream is possibly infinite. This method changes the fetchMode of this Result to Result.FetchMode.AGGRESSIVE to complete this as fast as possible.

Returns:

the newly created stream.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

next

@Nullable
public T next(long timeout,
                        java.util.concurrent.TimeUnit unit)
                 throws java.util.concurrent.TimeoutException

Returns the next element in the iteration, with a defined timeout.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the next element in the iteration

Throws:

java.util.NoSuchElementException - if the iteration has no more elements

java.util.concurrent.TimeoutException - if the poll operation times out

next

@Nullable
public T next()

Specified by:

next in interface java.util.Iterator<T>

first

@Nullable
public T first()

Returns the first object and closes the Result, discarding all other results. Throws if there's this result has no elements.

Returns:

the first result available.

single

@Nullable
public T single()

Returns the first object and closes the Result, discarding all other results. Throws if there's this result has no elements or more than one element.

Returns:

the first result available.

iterator

@NotNull
public @NotNull java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

forEach

public void forEach(java.util.function.Consumer<? super T> action)

Specified by:

forEach in interface java.lang.Iterable<T>

forEachRemaining

public void forEachRemaining(java.util.function.Consumer<? super T> action)

Specified by:

forEachRemaining in interface java.util.Iterator<T>

profile

@Nullable
public @Nullable Profile profile()

Gets the current's response Profile, if any.

Returns:

the Profile from the current response, or null

responseType

@NotNull
public @NotNull ResponseType responseType()

Returns the current responses' type.

Returns:

the ResponseType of the current response.

overrideFetchMode

@NotNull
public @NotNull Result<T> overrideFetchMode(Result.FetchMode fetchMode)

Overrides the fetch mode for this Result.

Parameters:

fetchMode - the new fetch mode.

Returns:

itself.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

currentResponse

protected Response currentResponse()

handleFirstResponse

protected void handleFirstResponse()

Function called on the first response.

throwOnCompleted

protected void throwOnCompleted()

maybeContinue

protected void maybeContinue()

onConnectionClosed

protected void onConnectionClosed()

emitData

protected int emitData(Response res)