Skip to content

Commit

Permalink
JavaDocs improvements
Browse files Browse the repository at this point in the history
Signed-off-by: Alfredo Gutierrez <[email protected]>
  • Loading branch information
AlfredoG87 committed Aug 14, 2024
1 parent 1f5713f commit ec5cca9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ private FileUtils() {}
PosixFilePermission.OTHERS_READ,
PosixFilePermission.OTHERS_EXECUTE));

/**
* Use this to create a Dir if it does not exist with the given permissions and log the result.
*
* @param blockNodePath the path to create
* @param logLevel the log level to use
* @param perms the permissions to use when creating the directory
* @throws IOException if the directory cannot be created
*/
public static void createPathIfNotExists(
@NonNull final Path blockNodePath,
@NonNull final System.Logger.Level logLevel,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ class BlockAsDirWriter implements BlockWriter<BlockItem> {
private final BlockNodeContext blockNodeContext;

/**
* Constructor for the BlockAsDirWriter class. It initializes the BlockAsDirWriter with the
* given key, config, block remover, and file permissions.
* Use the corresponding builder to construct a new BlockAsDirWriter with the
* given parameters.
*
* @param blockRemover the block remover to use to remove blocks if there is an exception while
* writing a partial block
* @param filePerms the file permissions to set on the block node root path
* @param blockRemover the block remover to use for removing blocks
* @param filePerms the file permissions to use for writing blocks
* @param blockNodeContext the block node context to use for writing blocks
* @throws IOException if an error occurs while initializing the BlockAsDirWriter
*/
BlockAsDirWriter(
Expand Down

0 comments on commit ec5cca9

Please sign in to comment.