Skip to content

Commit

Permalink
fix: refined javadocs
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Peterson <[email protected]>
  • Loading branch information
mattp-swirldslabs committed Aug 12, 2024
1 parent d5aa0bb commit be5d345
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <V> the type of the block to read
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,10 @@ public class BlockAsDirRemover implements BlockRemover {
private final FileAttribute<Set<PosixFilePermission>> 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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

0 comments on commit be5d345

Please sign in to comment.