Skip to content

Commit

Permalink
fix doc and format
Browse files Browse the repository at this point in the history
  • Loading branch information
TingDaoK committed Sep 4, 2024
1 parent dbb7510 commit ff232e1
Showing 1 changed file with 12 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -394,11 +394,12 @@ public Path getResponseFilePath() {
}

/**
* Sets the option for how to handle the response file when downloading an object
* from S3.
* Sets the option for how to handle the response file when downloading an
* object from S3.
* This option is only applicable when {@link withResponseFilePath} is set.
*
* By default, the option is set to {@link ResponseFileOption#CREATE_OR_REPLACE}.
* By default, the option is set to
* {@link ResponseFileOption#CREATE_OR_REPLACE}.
*
* @param responseFileOption The option for handling the response file.
* @return this
Expand All @@ -417,7 +418,8 @@ public ResponseFileOption getResponseFileOption() {
* This option is only applicable when {@link withResponseFileOption} is set
* to {@link ResponseFileOption#WRITE_TO_POSITION}.
*
* @param responseFilePosition The position to start writing to the response file.
* @param responseFilePosition The position to start writing to the response
* file.
* @return this
*/
public S3MetaRequestOptions withResponseFilePosition(long responseFilePosition) {
Expand All @@ -430,18 +432,19 @@ public long getResponseFilePosition() {
}

/**
* Sets whether to delete the response file on failure when downloading an object
* from S3.
* Sets whether to delete the response file on failure when downloading an
* object from S3.
* This option is only applicable when a response file path is set.
*
* @param responseFileDeleteOnFailure True to delete the response file on failure,
* false to leave it as-is.
* @param responseFileDeleteOnFailure True to delete the response file on
* failure,
* False to leave it as-is.
* @return this
*/
public S3MetaRequestOptions withResponseFileDeleteOnFailure(boolean responseFileDeleteOnFailure) {
this.responseFileDeleteOnFailure = responseFileDeleteOnFailure;
return this;
}

public boolean getResponseFileDeleteOnFailure() {
return responseFileDeleteOnFailure;
}
Expand Down

0 comments on commit ff232e1

Please sign in to comment.