From be5d345d065121dfa39084a14c94424de3d768a4 Mon Sep 17 00:00:00 2001 From: Matt Peterson Date: Mon, 12 Aug 2024 09:11:22 -0600 Subject: [PATCH] fix: refined javadocs Signed-off-by: Matt Peterson --- .../server/persistence/storage/read/BlockReader.java | 2 +- .../persistence/storage/remove/BlockAsDirRemover.java | 7 +++---- .../server/persistence/storage/remove/BlockRemover.java | 8 ++++---- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/server/src/main/java/com/hedera/block/server/persistence/storage/read/BlockReader.java b/server/src/main/java/com/hedera/block/server/persistence/storage/read/BlockReader.java index 7ac66e8d0..9f3442b4b 100644 --- a/server/src/main/java/com/hedera/block/server/persistence/storage/read/BlockReader.java +++ b/server/src/main/java/com/hedera/block/server/persistence/storage/read/BlockReader.java @@ -21,7 +21,7 @@ import java.util.Optional; /** - * The BlockReader interface defines the contract for reading a block from the storage. + * The BlockReader interface defines the contract for reading a block from storage. * * @param the type of the block to read */ diff --git a/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockAsDirRemover.java b/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockAsDirRemover.java index 49a8aae07..85d4c28fb 100644 --- a/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockAsDirRemover.java +++ b/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockAsDirRemover.java @@ -38,11 +38,10 @@ public class BlockAsDirRemover implements BlockRemover { private final FileAttribute> filePerms; /** - * Constructor for the BlockAsDirRemover class. It initializes the BlockAsDirRemover with the - * given parameters. + * Create a block remover to manage removing blocks from storage. * - * @param blockNodeRootPath the root path where the block files are stored - * @param filePerms the file permissions to set on the block node root path + * @param blockNodeRootPath the root path where blocks are stored. + * @param filePerms the file permissions used to manage removing blocks. */ public BlockAsDirRemover( @NonNull final Path blockNodeRootPath, diff --git a/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockRemover.java b/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockRemover.java index d2232c0c2..bee39bed8 100644 --- a/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockRemover.java +++ b/server/src/main/java/com/hedera/block/server/persistence/storage/remove/BlockRemover.java @@ -18,14 +18,14 @@ import java.io.IOException; -/** The BlockRemover interface defines the contract for removing a block from the storage. */ +/** The BlockRemover interface defines the contract for removing a block from storage. */ public interface BlockRemover { /** - * Removes the block with the given block number. + * Remove a block with the given block number. * - * @param blockNumber the block number of the block to remove - * @throws IOException if an I/O error occurs removing the block + * @param blockNumber the block number of the block to remove. + * @throws IOException when failing to remove a block. */ void remove(final long blockNumber) throws IOException; }