Auto-format

lmdbjava · stroomdev66 · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025
commit 72b5234561243a6f589d4355e7718e92f538bc86
diff --git a/src/main/java/org/lmdbjava/AbstractFlagSet.java b/src/main/java/org/lmdbjava/AbstractFlagSet.java
@@ -24,9 +24,11 @@
 import java.util.function.Function;
 import java.util.function.Supplier;
 
-/** Encapsulates an immutable set of flags and the associated bit mask for the flags in the set.
+/**
+ * Encapsulates an immutable set of flags and the associated bit mask for the flags in the set.
+ *
  * @param <T> The type of the flags in this set. Must extend {@link MaskedFlag} and {@link Enum<T>}.
- * */
+ */
 abstract class AbstractFlagSet<T extends Enum<T> & MaskedFlag> implements FlagSet<T> {
 
   private final Set<T> flags;
@@ -93,7 +95,7 @@
    return FlagSet.asString(this);
  }

  abstract static class AbstractSingleFlagSet<T extends Enum<T> & MaskedFlag>
      implements FlagSet<T> {

    private final T flag;
@@ -268,6 +270,7 @@
 
     /**
      * Replaces any flags already set in the builder with the passed flags.
+     *
      * @param flags The flags to set in the builder.
      * @return this builder instance.
      */

diff --git a/src/main/java/org/lmdbjava/ByteUnit.java b/src/main/java/org/lmdbjava/ByteUnit.java
@@ -62,6 +62,7 @@ public long toBytes(final long value) {
 
   /**
    * Gets factor to apply when converting this unit into bytes.
+   *
    * @return The factor to apply when converting this unit into bytes.
    */
   public long getFactor() {

diff --git a/src/main/java/org/lmdbjava/CopyFlagSet.java b/src/main/java/org/lmdbjava/CopyFlagSet.java
@@ -22,13 +22,12 @@
 /** An immutable set of flags for use when performing a {@link Env#copy(Path, CopyFlagSet)}. */
 public interface CopyFlagSet extends FlagSet<CopyFlags> {
 
-  /**
-   * An immutable empty {@link CopyFlagSet}.
-   */
+  /** An immutable empty {@link CopyFlagSet}. */
   CopyFlagSet EMPTY = CopyFlagSetImpl.EMPTY;
 
   /**
    * Gets the immutable empty {@link CopyFlagSet} instance.
+   *
    * @return The immutable empty {@link CopyFlagSet} instance.
    */
   static CopyFlagSet empty() {
@@ -37,6 +36,7 @@ static CopyFlagSet empty() {
 
   /**
    * Creates an immutable {@link CopyFlagSet} containing copyFlag.
+   *
    * @param copyFlag The flag to include in the {@link CopyFlagSet}
    * @return An immutable {@link CopyFlagSet} containing just copyFlag.
    */
@@ -47,6 +47,7 @@ static CopyFlagSet of(final CopyFlags copyFlag) {
 
   /**
    * Creates an immutable {@link CopyFlagSet} containing copyFlags.
+   *
    * @param copyFlags The flags to include in the {@link CopyFlagSet}.
    * @return An immutable {@link CopyFlagSet} containing copyFlags.
    */
@@ -56,6 +57,7 @@ static CopyFlagSet of(final CopyFlags... copyFlags) {
 
   /**
    * Creates an immutable {@link CopyFlagSet} containing copyFlags.
+   *
    * @param copyFlags The flags to include in the {@link CopyFlagSet}.
    * @return An immutable {@link CopyFlagSet} containing copyFlags.
    */
@@ -65,6 +67,7 @@ static CopyFlagSet of(final Collection<CopyFlags> copyFlags) {
 
   /**
    * Create a builder for building an {@link CopyFlagSet}.
+   *
    * @return A builder instance for building an {@link CopyFlagSet}.
    */
   static AbstractFlagSet.Builder<CopyFlags, CopyFlagSet> builder() {

diff --git a/src/main/java/org/lmdbjava/CopyFlagSetEmpty.java b/src/main/java/org/lmdbjava/CopyFlagSetEmpty.java
@@ -16,5 +16,4 @@
 package org.lmdbjava;
 
 class CopyFlagSetEmpty extends AbstractFlagSet.AbstractEmptyFlagSet<CopyFlags>
-    implements CopyFlagSet {
-}
+    implements CopyFlagSet {}
diff --git a/src/main/java/org/lmdbjava/Dbi.java b/src/main/java/org/lmdbjava/Dbi.java
@@ -279,6 +279,7 @@ public byte[] getName() {
 
   /**
    * Obtains the name of this database, using the {@link Env#DEFAULT_NAME_CHARSET} {@link Charset}.
+   *
    * @return The name of this database, using the {@link Env#DEFAULT_NAME_CHARSET} {@link Charset}.
    */
   public String getNameAsString() {
@@ -288,7 +289,8 @@ public String getNameAsString() {
   /**
    * Obtains the name of this database, using the supplied {@link Charset}.
    *
-   * @param charset The {@link Charset} to use when converting the DB from a byte[] to a {@link String}.
+   * @param charset The {@link Charset} to use when converting the DB from a byte[] to a {@link
+   *     String}.
    * @return The name of the database. If this is the unnamed database an empty string will be
    *     returned.
    * @throws RuntimeException if the name can't be decoded.

diff --git a/src/main/java/org/lmdbjava/DbiBuilder.java b/src/main/java/org/lmdbjava/DbiBuilder.java
@@ -109,14 +109,12 @@ private Stage2(final DbiBuilder<T> dbiBuilder) {
      * functionally identical.
      *
      * <p>This option may be slightly more performant than when using {@link
-     * Stage2#withNativeComparator()} which calls down to LMDB for ALL comparison
-     * operations.
+     * Stage2#withNativeComparator()} which calls down to LMDB for ALL comparison operations.
      *
      * <p>If you do not intend to use {@link CursorIterable} then it doesn't matter whether you
-     * choose {@link Stage2#withNativeComparator()}, {@link
-     * Stage2#withDefaultComparator()} or {@link
-     * Stage2#withIteratorComparator(ComparatorFactory)} as these comparators will never
-     * be used.
+     * choose {@link Stage2#withNativeComparator()}, {@link Stage2#withDefaultComparator()} or
+     * {@link Stage2#withIteratorComparator(ComparatorFactory)} as these comparators will never be
+     * used.
      *
      * @return The next builder stage.
      */
@@ -131,15 +129,13 @@ public Stage3<T> withDefaultComparator() {
      * keys using the same comparator that is used for insertion order into the db.
      *
      * <p>This option may be slightly less performant than when using {@link
-     * Stage2#withDefaultComparator()} as it needs to call down to LMDB to perform the
-     * comparisons, however it guarantees that {@link CursorIterable} key comparison matches LMDB
-     * key comparison.
+     * Stage2#withDefaultComparator()} as it needs to call down to LMDB to perform the comparisons,
+     * however it guarantees that {@link CursorIterable} key comparison matches LMDB key comparison.
      *
      * <p>If you do not intend to use {@link CursorIterable} then it doesn't matter whether you
-     * choose {@link Stage2#withNativeComparator()}, {@link
-     * Stage2#withDefaultComparator()} or {@link
-     * Stage2#withIteratorComparator(ComparatorFactory)} as these comparators will never
-     * be used.
+     * choose {@link Stage2#withNativeComparator()}, {@link Stage2#withDefaultComparator()} or
+     * {@link Stage2#withIteratorComparator(ComparatorFactory)} as these comparators will never be
+     * used.
      *
      * @return The next builder stage.
      */
@@ -167,8 +163,7 @@ public Stage3<T> withNativeComparator() {
      *     the {@link Dbi}. It must not return null.
      * @return The next builder stage.
      */
-    public Stage3<T> withCallbackComparator(
-        final ComparatorFactory<T> comparatorFactory) {
+    public Stage3<T> withCallbackComparator(final ComparatorFactory<T> comparatorFactory) {
       this.comparatorFactory = Objects.requireNonNull(comparatorFactory);
       this.comparatorType = ComparatorType.CALLBACK;
       return new Stage3<>(this);
@@ -189,18 +184,16 @@ public Stage3<T> withCallbackComparator(
      * when using {@link CursorIterable}.
      *
      * <p>If you do not intend to use {@link CursorIterable} then it doesn't matter whether you
-     * choose {@link Stage2#withNativeComparator()}, {@link
-     * Stage2#withDefaultComparator()} or {@link
-     * Stage2#withIteratorComparator(ComparatorFactory)} as these comparators will never
-     * be used.
+     * choose {@link Stage2#withNativeComparator()}, {@link Stage2#withDefaultComparator()} or
+     * {@link Stage2#withIteratorComparator(ComparatorFactory)} as these comparators will never be
+     * used.
      *
      * @param comparatorFactory The comparator to use with {@link CursorIterable}. {@link
      *     ComparatorFactory#create(DbiFlagSet)} will be called once during the initialisation of
      *     the {@link Dbi}. It must not return null.
      * @return The next builder stage.
      */
-    public Stage3<T> withIteratorComparator(
-        final ComparatorFactory<T> comparatorFactory) {
+    public Stage3<T> withIteratorComparator(final ComparatorFactory<T> comparatorFactory) {
       this.comparatorFactory = Objects.requireNonNull(comparatorFactory);
       this.comparatorType = ComparatorType.ITERATOR;
       return new Stage3<>(this);
@@ -227,8 +220,8 @@ private Stage3(Stage2<T> stage2) {
      * Apply all the dbi flags supplied in dbiFlags.
      *
      * <p>Clears all flags currently set by previous calls to {@link
-     * Stage3#setDbiFlags(Collection)}, {@link Stage3#setDbiFlags(DbiFlags...)}
-     * or {@link Stage3#addDbiFlag(DbiFlags)}.
+     * Stage3#setDbiFlags(Collection)}, {@link Stage3#setDbiFlags(DbiFlags...)} or {@link
+     * Stage3#addDbiFlag(DbiFlags)}.
      *
      * @param dbiFlags to open the database with. A null {@link Collection} will just clear all set
      *     flags. Null items are ignored.
@@ -246,8 +239,8 @@ public Stage3<T> setDbiFlags(final Collection<DbiFlags> dbiFlags) {
      * Apply all the dbi flags supplied in dbiFlags.
      *
      * <p>Clears all flags currently set by previous calls to {@link
-     * Stage3#setDbiFlags(Collection)}, {@link Stage3#setDbiFlags(DbiFlags...)}
-     * or {@link Stage3#addDbiFlag(DbiFlags)}.
+     * Stage3#setDbiFlags(Collection)}, {@link Stage3#setDbiFlags(DbiFlags...)} or {@link
+     * Stage3#addDbiFlag(DbiFlags)}.
      *
      * @param dbiFlags to open the database with. A null array will just clear all set flags. Null
      *     items are ignored.
@@ -265,8 +258,8 @@ public Stage3<T> setDbiFlags(final DbiFlags... dbiFlags) {
      * Apply all the dbi flags supplied in dbiFlags.
      *
      * <p>Clears all flags currently set by previous calls to {@link
-     * Stage3#setDbiFlags(Collection)}, {@link Stage3#setDbiFlags(DbiFlags...)}
-     * or {@link Stage3#addDbiFlag(DbiFlags)}.
+     * Stage3#setDbiFlags(Collection)}, {@link Stage3#setDbiFlags(DbiFlags...)} or {@link
+     * Stage3#addDbiFlag(DbiFlags)}.
      *
      * @param dbiFlagSet to open the database with. A null value will just clear all set flags.
      * @return This builder instance.
@@ -281,8 +274,8 @@ public Stage3<T> setDbiFlags(final DbiFlagSet dbiFlagSet) {
 
     /**
      * Adds a dbiFlag to those flags already added to this builder by {@link
-     * Stage3#setDbiFlags(DbiFlags...)}, {@link Stage3#setDbiFlags(Collection)}
-     * or {@link Stage3#addDbiFlag(DbiFlags)}.
+     * Stage3#setDbiFlags(DbiFlags...)}, {@link Stage3#setDbiFlags(Collection)} or {@link
+     * Stage3#addDbiFlag(DbiFlags)}.
      *
      * @param dbiFlag to add to any existing flags. A null value is a no-op.
      * @return this builder instance.
@@ -294,8 +287,8 @@ public Stage3<T> addDbiFlag(final DbiFlags dbiFlag) {
 
     /**
      * Adds a dbiFlag to those flags already added to this builder by {@link
-     * Stage3#setDbiFlags(DbiFlags...)}, {@link Stage3#setDbiFlags(Collection)}
-     * or {@link Stage3#addDbiFlag(DbiFlags)}.
+     * Stage3#setDbiFlags(DbiFlags...)}, {@link Stage3#setDbiFlags(Collection)} or {@link
+     * Stage3#addDbiFlag(DbiFlags)}.
      *
      * @param dbiFlagSet to add to any existing flags. A null value is a no-op.
      * @return this builder instance.
@@ -310,8 +303,8 @@ public Stage3<T> addDbiFlags(final DbiFlagSet dbiFlagSet) {
     /**
      * Use the supplied transaction to open the {@link Dbi}.
      *
-     * <p>The caller MUST commit the transaction after calling {@link Stage3#open()}, in
-     * order to retain the <code>Dbi</code> in the <code>Env</code>.
+     * <p>The caller MUST commit the transaction after calling {@link Stage3#open()}, in order to
+     * retain the <code>Dbi</code> in the <code>Env</code>.
      *
      * <p>If you don't call this method to supply a {@link Txn}, a {@link Txn} will be opened for
      * the purpose of creating and opening the {@link Dbi}, then closed. Therefore, if you already
@@ -413,6 +406,7 @@ private enum ComparatorType {
 
   /**
    * A factory for creating a {@link Comparator} from a {@link DbiFlagSet}
+   *
    * @param <T> The type of buffer that will be compared by the created {@link Comparator}.
    */
   @FunctionalInterface
@@ -422,8 +416,8 @@ public interface ComparatorFactory<T> {
      * Creates a comparator for the supplied {@link DbiFlagSet}. This will only be called once
      * during the initialisation of the {@link Dbi}.
      *
-     * @param dbiFlagSet The flags set on the DB that the returned {@link Comparator} will be used by.
-     *                   The flags in the set may impact how the returned {@link Comparator} should behave.
+     * @param dbiFlagSet The flags set on the DB that the returned {@link Comparator} will be used
+     *     by. The flags in the set may impact how the returned {@link Comparator} should behave.
      * @return A {@link Comparator} applicable to the passed DB flags.
      */
     Comparator<T> create(final DbiFlagSet dbiFlagSet);

diff --git a/src/main/java/org/lmdbjava/DbiFlagSet.java b/src/main/java/org/lmdbjava/DbiFlagSet.java
@@ -29,6 +29,7 @@ public interface DbiFlagSet extends FlagSet<DbiFlags> {
 
   /**
    * Gets the immutable empty {@link DbiFlagSet} instance.
+   *
    * @return The immutable empty {@link DbiFlagSet} instance.
    */
   static DbiFlagSet empty() {
@@ -37,6 +38,7 @@ static DbiFlagSet empty() {
 
   /**
    * Creates an immutable {@link DbiFlagSet} containing dbiFlag.
+   *
    * @param dbiFlag The flag to include in the {@link DbiFlagSet}
    * @return An immutable {@link DbiFlagSet} containing just dbiFlag.
    */
@@ -47,6 +49,7 @@ static DbiFlagSet of(final DbiFlags dbiFlag) {
 
   /**
    * Creates an immutable {@link DbiFlagSet} containing dbiFlags.
+   *
    * @param dbiFlags The flags to include in the {@link DbiFlagSet}.
    * @return An immutable {@link DbiFlagSet} containing dbiFlags.
    */
@@ -56,6 +59,7 @@ static DbiFlagSet of(final DbiFlags... dbiFlags) {
 
   /**
    * Creates an immutable {@link DbiFlagSet} containing dbiFlags.
+   *
    * @param dbiFlags The flags to include in the {@link DbiFlagSet}.
    * @return An immutable {@link DbiFlagSet} containing dbiFlags.
    */
@@ -65,6 +69,7 @@ static DbiFlagSet of(final Collection<DbiFlags> dbiFlags) {
 
   /**
    * Create a builder for building an {@link DbiFlagSet}.
+   *
    * @return A builder instance for building an {@link DbiFlagSet}.
    */
   static AbstractFlagSet.Builder<DbiFlags, DbiFlagSet> builder() {

diff --git a/src/main/java/org/lmdbjava/DbiFlagSetEmpty.java b/src/main/java/org/lmdbjava/DbiFlagSetEmpty.java
@@ -16,5 +16,4 @@
 package org.lmdbjava;
 
 class DbiFlagSetEmpty extends AbstractFlagSet.AbstractEmptyFlagSet<DbiFlags>
-    implements DbiFlagSet {
-}
+    implements DbiFlagSet {}
diff --git a/src/main/java/org/lmdbjava/Env.java b/src/main/java/org/lmdbjava/Env.java
@@ -55,8 +55,8 @@ public final class Env<T> implements AutoCloseable {
   public static final String DISABLE_CHECKS_PROP = "lmdbjava.disable.checks";
 
   /**
-   * The default {@link Charset} used to convert DB names from a byte[] to a String or
-   * to encode a String as a byte[]. Only used if not explicit {@link Charset} is provided.
+   * The default {@link Charset} used to convert DB names from a byte[] to a String or to encode a
+   * String as a byte[]. Only used if not explicit {@link Charset} is provided.
    */
   public static final Charset DEFAULT_NAME_CHARSET = StandardCharsets.UTF_8;
 

diff --git a/src/main/java/org/lmdbjava/EnvFlagSet.java b/src/main/java/org/lmdbjava/EnvFlagSet.java
@@ -21,13 +21,12 @@
 /** An immutable set of flags for use when opening the {@link Env}. */
 public interface EnvFlagSet extends FlagSet<EnvFlags> {
 
-  /**
-   * An immutable empty {@link EnvFlagSet}.
-   */
+  /** An immutable empty {@link EnvFlagSet}. */
   EnvFlagSet EMPTY = EnvFlagSetImpl.EMPTY;
 
   /**
    * Gets the immutable empty {@link EnvFlagSet} instance.
+   *
    * @return The immutable empty {@link EnvFlagSet} instance.
    */
   static EnvFlagSet empty() {
@@ -36,6 +35,7 @@ static EnvFlagSet empty() {
 
   /**
    * Creates an immutable {@link EnvFlagSet} containing envFlag.
+   *
    * @param envFlag The flag to include in the {@link EnvFlagSet}
    * @return An immutable {@link EnvFlagSet} containing just envFlag.
    */
@@ -46,6 +46,7 @@ static EnvFlagSet of(final EnvFlags envFlag) {
 
   /**
    * Creates an immutable {@link EnvFlagSet} containing envFlags.
+   *
    * @param envFlags The flags to include in the {@link EnvFlagSet}.
    * @return An immutable {@link EnvFlagSet} containing envFlags.
    */
@@ -55,6 +56,7 @@ static EnvFlagSet of(final EnvFlags... envFlags) {
 
   /**
    * Creates an immutable {@link EnvFlagSet} containing envFlags.
+   *
    * @param envFlags The flags to include in the {@link EnvFlagSet}.
    * @return An immutable {@link EnvFlagSet} containing envFlags.
    */
@@ -64,6 +66,7 @@ static EnvFlagSet of(final Collection<EnvFlags> envFlags) {
 
   /**
    * Create a builder for building an {@link EnvFlagSet}.
+   *
    * @return A builder instance for building an {@link EnvFlagSet}.
    */
   static AbstractFlagSet.Builder<EnvFlags, EnvFlagSet> builder() {

diff --git a/src/main/java/org/lmdbjava/EnvFlagSetEmpty.java b/src/main/java/org/lmdbjava/EnvFlagSetEmpty.java
@@ -16,5 +16,4 @@
 package org.lmdbjava;
 
 class EnvFlagSetEmpty extends AbstractFlagSet.AbstractEmptyFlagSet<EnvFlags>
-    implements EnvFlagSet {
-}
+    implements EnvFlagSet {}
-Original file line number
+Diff line change
@@ Expand Up / @@ -62,6 +62,7 @@ public long toBytes(final long value) { @@
       /**
        * Gets factor to apply when converting this unit into bytes.
+       *
        * @return The factor to apply when converting this unit into bytes.
        */
       public long getFactor() {
@@ Expand Down @@