From ca7046cda47bb9a54fa492f866f00c826b1516b1 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Thu, 10 Oct 2013 14:51:41 +0000
Subject: [PATCH] OPENDJ-1116 Introduce abstraction for the changelog DB
---
opends/src/server/org/opends/server/replication/server/changelog/api/DBCursor.java | 12 ++++++++++++
1 files changed, 12 insertions(+), 0 deletions(-)
diff --git a/opends/src/server/org/opends/server/replication/server/changelog/api/DBCursor.java b/opends/src/server/org/opends/server/replication/server/changelog/api/DBCursor.java
index 8de00fb..3c1a43d 100644
--- a/opends/src/server/org/opends/server/replication/server/changelog/api/DBCursor.java
+++ b/opends/src/server/org/opends/server/replication/server/changelog/api/DBCursor.java
@@ -32,6 +32,18 @@
* Generic cursor interface into the changelog database. Once it is not used
* anymore, a cursor must be closed to release all the resources into the
* database.
+ * <p>
+ * Here is a typical usage pattern:
+ *
+ * <pre>
+ * DBCursor<T> cursor = ...; // obtain a new cursor,
+ * // already initialized
+ * T record1 = cursor.getRecord(); // get the first record
+ * while (cursor.next()) { // advance to the next record
+ * T record = cursor.getRecord(); // get the next record
+ * ... // etc.
+ * }
+ * </pre>
*
* @param <T>
* type of the record being returned
--
Gitblit v1.10.0