Commit eca4f57

committed

doc

1 parent 8bcc43c commit eca4f57Copy full SHA for eca4f57

File tree

+26

-6

lines changed

core/src/main/java/com/arangodb
- ArangoCursor.java
- model
  - AqlQueryOptions.java

+26

-6

lines changed

Lines changed: 18 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,12 @@`
`22`	`22`
`23`	`23`	`import com.arangodb.entity.CursorStats;`
`24`	`24`	`import com.arangodb.entity.CursorWarning;`
	`25`	`+import com.arangodb.model.AqlQueryOptions;`
`25`	`26`
`26`	`27`	`import java.io.Closeable;`
`27`	`28`	`import java.util.Collection;`
`28`	`29`	`import java.util.List;`
	`30`	`+import java.util.NoSuchElementException;`
`29`	`31`
`30`	`32`	`/**`
`31`	`33`	`* @author Mark Vollmary`
`@@ -83,4 +85,20 @@ public interface ArangoCursor<T> extends ArangoIterable<T>, ArangoIterator<T>, C`
`83`	`85`	`*/`
`84`	`86`	`String getNextBatchId();`
`85`	`87`
	`88`	`+ /**`
	`89`	`+ * Returns the next element in the iteration.`
	`90`	`+ * <p/>`
	`91`	`+ * If the cursor allows retries (see {@link AqlQueryOptions#allowRetry(Boolean)}), then it is safe to retry invoking`
	`92`	`+ * this method in case of I/O exceptions (which are actually thrown as {@link com.arangodb.ArangoDBException} with`
	`93`	`+ * cause {@link java.io.IOException}).`
	`94`	`+ * <p/>`
	`95`	`+ * If the cursor does not allow retries (default), then it is not safe to retry invoking this method in case of I/O`
	`96`	`+ * exceptions, since the request to fetch the next batch is not idempotent (i.e. the cursor may advance multiple`
	`97`	`+ * times on the server).`
	`98`	`+ *`
	`99`	`+ * @return the next element in the iteration`
	`100`	`+ * @throws NoSuchElementException if the iteration has no more elements`
	`101`	`+ */`
	`102`	`+ @Override`
	`103`	`+ T next();`
`86`	`104`	`}`

Lines changed: 8 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -493,13 +493,15 @@ public Boolean getAllowRetry() {`
`493`	`493`
`494`	`494`	`/**`
`495`	`495`	`* @param allowRetry Set this option to true to make it possible to retry fetching the latest batch from a cursor.`
	`496`	`+ * <p/>`
`496`	`497`	`* This makes possible to safely retry invoking {@link com.arangodb.ArangoCursor#next()} in`
`497`		`- * case of {@link java.io.IOException}.`
`498`		`- * <p>`
`499`		`- * If set to false (default), retry invoking {@link com.arangodb.ArangoCursor#next()} in case of`
`500`		`- * {@link java.io.IOException} is not safe, since the request to fetch the next batch is not`
`501`		`- * idempotent (i.e. the cursor may be advanced multiple times on the server).`
`502`		`- *`
	`498`	`+ * case of I/O exceptions (which are actually thrown as {@link com.arangodb.ArangoDBException}`
	`499`	`+ * with cause {@link java.io.IOException})`
	`500`	`+ * <p/>`
	`501`	`+ * If set to false (default), then it is not safe to retry invoking`
	`502`	`+ * {@link com.arangodb.ArangoCursor#next()} in case of I/O exceptions, since the request to`
	`503`	`+ * fetch the next batch is not idempotent (i.e. the cursor may advance multiple times on the`
	`504`	`+ * server).`
`503`	`505`	`* @return options`
`504`	`506`	`* @since ArangoDB 3.11`
`505`	`507`	`*/`

Comments

(0)