From 1c2bee3b96b9fbe0ddd6e95516db786e017c587e Mon Sep 17 00:00:00 2001
From: Jean-Noël Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Fri, 02 Oct 2015 15:34:44 +0000
Subject: [PATCH] Final manual cleanup

---
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/State.java               |    8 +++++---
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexBuffer.java         |    1 -
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pdb/PDBStorage.java                |    2 +-
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ID2Count.java            |    1 -
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/OnDiskMergeImporter.java |   21 +++++++--------------
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java      |    4 +---
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/TracedStorage.java       |    1 -
 opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java          |    3 ++-
 8 files changed, 16 insertions(+), 25 deletions(-)

diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pdb/PDBStorage.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pdb/PDBStorage.java
index 485c2a1..41d57a5 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pdb/PDBStorage.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pdb/PDBStorage.java
@@ -27,6 +27,7 @@
 
 import static com.persistit.Transaction.CommitPolicy.*;
 import static java.util.Arrays.*;
+
 import static org.opends.messages.BackendMessages.*;
 import static org.opends.messages.ConfigMessages.*;
 import static org.opends.messages.UtilityMessages.*;
@@ -104,7 +105,6 @@
 import com.persistit.mxbeans.CheckpointManagerMXBean;
 
 /** PersistIt database implementation of the {@link Storage} engine. */
-@SuppressWarnings("javadoc")
 public final class PDBStorage implements Storage, Backupable, ConfigurationChangeListener<PDBBackendCfg>,
   DiskSpaceMonitorHandler
 {
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
index ac2ffe6..fb3106e 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/AttributeIndex.java
@@ -71,9 +71,7 @@
  * by the ordering matching rule.  If these could be guaranteed to be identical
  * then we would not need a separate ordering index.
  */
-@SuppressWarnings("javadoc")
-class AttributeIndex
-    implements ConfigurationChangeListener<BackendIndexCfg>, Closeable
+class AttributeIndex implements ConfigurationChangeListener<BackendIndexCfg>, Closeable
 {
   private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
 
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java
index 1c591a2..c4aa112 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryIDSet.java
@@ -46,7 +46,6 @@
  * Represents a set of Entry IDs. It can represent a set where the IDs are not defined, for example when the index entry
  * limit has been exceeded.
  */
-@SuppressWarnings("javadoc")
 final class EntryIDSet implements Iterable<EntryID>
 {
   public static final EntryIDSetCodec CODEC_V1 = new EntryIDSetCodecV1();
@@ -348,11 +347,13 @@
     @Override
     public void addAll(EntryIDSet that)
     {
+      // this has no effect
     }
 
     @Override
     public void removeAll(EntryIDSet that)
     {
+      // this has no effect
     }
 
     @Override
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ID2Count.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ID2Count.java
index 7029c73..e974319 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ID2Count.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/ID2Count.java
@@ -43,7 +43,6 @@
  * Store a counter associated to a key. Counter value is sharded amongst multiple keys to allow concurrent
  * update without contention (at the price of a slower read).
  */
-@SuppressWarnings("javadoc")
 final class ID2Count extends AbstractTree
 {
   /**
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexBuffer.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexBuffer.java
index 92093d7..c4682a3 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexBuffer.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/IndexBuffer.java
@@ -48,7 +48,6 @@
  * the same transaction. The transaction may be null if it is known
  * that there are no other concurrent updates to the index.
  */
-@SuppressWarnings("javadoc")
 class IndexBuffer
 {
   /** Internal interface for IndexBuffer implementor. */
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/OnDiskMergeImporter.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/OnDiskMergeImporter.java
index 83f4f5a..265e353 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/OnDiskMergeImporter.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/OnDiskMergeImporter.java
@@ -824,16 +824,6 @@
       visitIndexes(entryContainer, new TrustModifier(importer, true));
     }
 
-    final Set<EntryContainer> extractEntryContainers(Collection<TreeName> treeNames)
-    {
-      final Set<EntryContainer> containers = new HashSet<>();
-      for(TreeName treeName : treeNames)
-      {
-        containers.add(entryContainers.get(treeName.getBaseDN()));
-      }
-      return containers;
-    }
-
     final void clearEntryContainerTrees(EntryContainer entryContainer)
     {
       for(Tree tree : entryContainer.listTrees())
@@ -1198,8 +1188,8 @@
 
   /**
    * Chunk implementations are a data storage with an optional limited capacity. Chunk are typically used by first
-   * adding data to the storage using {@link put(ByteSequence, ByteSequence)} later on data can be sequentially accessed
-   * using {@link flip()}.
+   * adding data to the storage using {@link #put(ByteSequence, ByteSequence)} later on data can be sequentially accessed
+   * using {@link #flip()}.
    */
   interface Chunk
   {
@@ -1235,8 +1225,9 @@
    * Store and sort data into multiple chunks. Thanks to the chunk rolling mechanism, this chunk can sort and store an
    * unlimited amount of data. This class uses double-buffering: data are firstly stored in a
    * {@link InMemorySortedChunk} which, once full, will be asynchronously sorted and copied into a
-   * {@link FileRegionChunk}. Duplicate keys are reduced by a {@link Collector}. {@link #put(ByteSequence,
-   * ByteSequence))} is thread-safe. This class is used in phase-one. There is one {@link ExternalSortChunk} per
+   * {@link FileRegionChunk}. Duplicate keys are reduced by a {@link Collector}.
+   * {@link #put(ByteSequence, ByteSequence))} is thread-safe.
+   * This class is used in phase-one. There is one {@link ExternalSortChunk} per
    * database tree, shared across all phase-one importer threads, in charge of storing/sorting records.
    */
   static final class ExternalSortChunk implements Chunk
@@ -2264,6 +2255,7 @@
     @Override
     public void close()
     {
+      // nothing to do
     }
   }
 
@@ -2394,6 +2386,7 @@
         @Override
         public void close()
         {
+          // nothing to do
         }
 
         @Override
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/State.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/State.java
index 75cd837..2900c4d 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/State.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/State.java
@@ -109,7 +109,8 @@
   /**
    * Ensure that the specified flags are set for the given index
    * @param txn a non null transaction
-   * @param index The index storing the trusted state info.
+   * @param indexTreeName The index storing the trusted state info.
+   * @param flags The flags to add to the provided index
    * @return true if the flags have been updated
    * @throws NullPointerException if txn, index or flags is null
    * @throws StorageRuntimeException If an error occurs in the storage.
@@ -159,7 +160,8 @@
   /**
    * Ensure that the specified flags are not set for the given index
    * @param txn a non null transaction
-   * @param index The index storing the trusted state info.
+   * @param indexTreeName The index storing the trusted state info.
+   * @param flags The flags to remove from the provided index
    * @throws NullPointerException if txn, index or flags is null
    * @throws StorageRuntimeException If an error occurs in the storage.
    */
@@ -184,7 +186,7 @@
    * Remove a record from the entry tree.
    *
    * @param txn a non null transaction
-   * @param index The index storing the trusted state info.
+   * @param indexTreeName The index storing the trusted state info.
    * @return true if the entry was removed, false if it was not.
    * @throws NullPointerException if txn, index is null
    * @throws StorageRuntimeException If an error occurs in the storage.
diff --git a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/TracedStorage.java b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/TracedStorage.java
index 34fb15d..bd80d92 100644
--- a/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/TracedStorage.java
+++ b/opendj-sdk/opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/TracedStorage.java
@@ -50,7 +50,6 @@
 import org.opends.server.types.RestoreConfig;
 
 /** Decorates a {@link Storage} with additional trace logging. */
-@SuppressWarnings("javadoc")
 final class TracedStorage implements Storage
 {
   /** Decorates an {@link Importer} with additional trace logging. */

--
Gitblit v1.10.0