From a54fa3d78b427d7b8278442acbe86ebebcf6c2e7 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 27 Jan 2015 11:31:59 +0000
Subject: [PATCH] OPENDJ-1716 Various PluggableBackend/Storage refactorings Code review: Nicolas Capponi

---
 opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/ReadOperation.java |   19 +++++++++++++++++--
 1 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/ReadOperation.java b/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/ReadOperation.java
index 9d9fd6c..d401864 100644
--- a/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/ReadOperation.java
+++ b/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/ReadOperation.java
@@ -21,12 +21,27 @@
  * CDDL HEADER END
  *
  *
- *      Copyright 2014 ForgeRock AS
+ *      Copyright 2014-2015 ForgeRock AS
  */
-
 package org.opends.server.backends.pluggable.spi;
 
+/**
+ * Function performing a read operation.
+ *
+ * @param <T>
+ *          type of the value that is read and returned by this read operation
+ */
+// @FunctionalInterface
 public interface ReadOperation<T>
 {
+  /**
+   * Executes a read operation, and returns the read value.
+   *
+   * @param txn
+   *          the read transaction where to execute the read operation
+   * @return the read value
+   * @throws Exception
+   *           if a problem occurs with the underlying storage engine
+   */
   T run(ReadableStorage txn) throws Exception;
 }
\ No newline at end of file

--
Gitblit v1.10.0