com.arangodb

Class ArangoCursor<T>

java.lang.Object

com.arangodb.ArangoCursor<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>, Iterator<T>

public class ArangoCursor<T>
extends Object
implements Iterable<T>, Iterator<T>, Closeable

Author:

Mark Vollmary

Field Summary

Fields

Modifier and Type	Field and Description
protected com.arangodb.internal.ArangoCursorIterator<T>	iterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArangoCursor(com.arangodb.internal.InternalArangoDatabase<?,?,?,?> db, com.arangodb.internal.ArangoCursorExecute execute, Class<T> type, CursorEntity result)

Method Summary

Modifier and Type	Method and Description
List<T>	asListRemaining()
void	close()
protected com.arangodb.internal.ArangoCursorIterator<T>	createIterator(ArangoCursor<T> cursor, com.arangodb.internal.InternalArangoDatabase<?,?,?,?> db, com.arangodb.internal.ArangoCursorExecute execute, CursorEntity result)
Integer	getCount()
String	getId()
CursorEntity.Stats	getStats()
Class<T>	getType()
Collection<CursorEntity.Warning>	getWarnings()
boolean	hasNext()
boolean	isCached()
Iterator<T>	iterator()
T	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

iterator

protected final com.arangodb.internal.ArangoCursorIterator<T> iterator

Constructor Detail

ArangoCursor

protected ArangoCursor(com.arangodb.internal.InternalArangoDatabase<?,?,?,?> db,
                       com.arangodb.internal.ArangoCursorExecute execute,
                       Class<T> type,
                       CursorEntity result)

Method Detail

createIterator

protected com.arangodb.internal.ArangoCursorIterator<T> createIterator(ArangoCursor<T> cursor,
                                                                       com.arangodb.internal.InternalArangoDatabase<?,?,?,?> db,
                                                                       com.arangodb.internal.ArangoCursorExecute execute,
                                                                       CursorEntity result)

getId

public String getId()

Returns:

id of temporary cursor created on the server

getType

public Class<T> getType()

getCount

public Integer getCount()

Returns:

the total number of result documents available (only available if the query was executed with the count attribute set)

getStats

public CursorEntity.Stats getStats()

getWarnings

public Collection<CursorEntity.Warning> getWarnings()

isCached

public boolean isCached()

Returns:

indicating whether the query result was served from the query cache or not

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

asListRemaining

public List<T> asListRemaining()

remove

public void remove()

Specified by:

remove in interface Iterator<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>