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/Importer.java |   25 ++++++++++++++++++++++---
 1 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/Importer.java b/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/Importer.java
index f2df235..a31a73a 100644
--- a/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/Importer.java
+++ b/opendj3-server-dev/src/server/org/opends/server/backends/pluggable/spi/Importer.java
@@ -21,21 +21,40 @@
  * CDDL HEADER END
  *
  *
- *      Copyright 2014 ForgeRock AS
+ *      Copyright 2014-2015 ForgeRock AS
  */
-
 package org.opends.server.backends.pluggable.spi;
 
 import java.io.Closeable;
 
 import org.forgerock.opendj.ldap.ByteSequence;
 
+/**
+ * Allows to run an import. For performance reasons, imports are run without transactions.
+ */
 public interface Importer extends Closeable
 {
+  /**
+   * Creates a new tree identified by the provided name.
+   *
+   * @param name
+   *          the tree name
+   */
   void createTree(TreeName name);
 
-  void put(TreeName name, ByteSequence key, ByteSequence value);
+  /**
+   * Creates a record with the provided key and value in the tree identified by the provided name.
+   *
+   * @param treeName
+   *          the tree name
+   * @param key
+   *          the new record's key
+   * @param value
+   *          the new record's value
+   */
+  void put(TreeName treeName, ByteSequence key, ByteSequence value);
 
+  /** {@inheritDoc} */
   @Override
   void close();
 }
\ No newline at end of file

--
Gitblit v1.10.0