Clean up internal packages (#1026)

* Ensure that every public type has Javadoc indicating it's not part of the public API
* Remove boilerplate Javadoc
* Remove some unused methods

Author: jyemin

bson/src/main/org/bson/internal/ProvidersCodecRegistry.java

@@ -31,6 +31,9 @@
 import static org.bson.assertions.Assertions.isTrueArgument;
 import static org.bson.assertions.Assertions.notNull;
 
+/**
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
+ */
 public final class ProvidersCodecRegistry implements CycleDetectingCodecRegistry {
     private final List<CodecProvider> codecProviders;
     private final CodecCache codecCache = new CodecCache();

bson/src/main/org/bson/internal/UuidHelper.java

@@ -26,6 +26,8 @@
 
 /**
  * Utilities for encoding and decoding UUID into binary.
+ *
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 public final class UuidHelper {
     private static void writeLongToArrayBigEndian(final byte[] bytes, final int offset, final long x) {

driver-core/src/main/com/mongodb/internal/CheckedSupplier.java

@@ -17,7 +17,7 @@
 package com.mongodb.internal;
 
 /**
- * This class is not part of the public API and may be removed or changed at any time.
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 @FunctionalInterface
 public interface CheckedSupplier<T, E extends Exception> {

driver-core/src/main/com/mongodb/internal/HexUtils.java

@@ -21,7 +21,7 @@
 import java.security.NoSuchAlgorithmException;
 
 /**
- * This class is not part of the public API and may be removed or changed at any time.
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 public final class HexUtils {
     /**

driver-core/src/main/com/mongodb/internal/IgnorableRequestContext.java

@@ -24,6 +24,8 @@
 /**
  * A {@link RequestContext} that can be ignored by the driver.  Useful to ensure that we always
  * have a non-null {@link RequestContext} to pass around the driver.
+ *
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 public final class IgnorableRequestContext implements RequestContext {
 

driver-core/src/main/com/mongodb/internal/Iterables.java

@@ -27,6 +27,9 @@
 import static java.util.Arrays.asList;
 import static java.util.Collections.singleton;
 
+/**
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
+ */
 public final class Iterables {
     @SafeVarargs
     @SuppressWarnings("varargs")

driver-core/src/main/com/mongodb/internal/Locks.java

@@ -22,7 +22,7 @@
 import java.util.function.Supplier;
 
 /**
- * This class is not part of the public API and may be removed or changed at any time.
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 public final class Locks {
     public static void withLock(final Lock lock, final Runnable action) {

driver-core/src/main/com/mongodb/internal/Timeout.java

@@ -30,6 +30,8 @@
 /**
  * A <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/doc-files/ValueBased.html">value-based</a> class
  * useful for tracking timeouts.
+ *
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 @Immutable
 public final class Timeout {

driver-core/src/main/com/mongodb/internal/VisibleForTesting.java

@@ -25,6 +25,8 @@
  * Denotes that the annotated program element is made more accessible than otherwise necessary for the purpose of testing.
  * The annotated program element must be used as if it had the {@linkplain #otherwise() intended} access modifier
  * for any purpose other than testing.
+ *
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 @Documented
 @Retention(RetentionPolicy.SOURCE)

driver-core/src/main/com/mongodb/internal/async/AsyncAggregateResponseBatchCursor.java

@@ -22,35 +22,14 @@
 /**
  * Extends the async batch cursor interface to include information included in an aggregate or getMore response.
  *
- * @param <T> The type of documents the cursor contains
- * @mongodb.driver.manual ../meta-driver/latest/legacy/mongodb-wire-protocol/#wire-op-get-more OP_GET_MORE
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
  */
 public interface AsyncAggregateResponseBatchCursor<T> extends AsyncBatchCursor<T> {
-    /**
-     * Returns the postBatchResumeToken.
-     *
-     * @return the postBatchResumeToken
-     */
     BsonDocument getPostBatchResumeToken();
 
-    /**
-     * Returns the operation time found in the aggregate or getMore response.
-     *
-     * @return the operation time
-     */
     BsonTimestamp getOperationTime();
 
-    /**
-     * Returns true if the first batch was empty.
-     *
-     * @return true if the first batch was empty
-     */
     boolean isFirstBatchEmpty();
 
-    /**
-     * Returns the max wire version.
-     *
-     * @return the max wire version
-     */
     int getMaxWireVersion();
 }