Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed May 23, 2024
1 parent 9fe54bf commit 70e442b
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ public boolean isInMemory() {
* Sets the default charset for use when no explicit charset parameter is provided by the sender.
*
* @param charset the default charset
* @return this
* @return {@code this} instance.
*/
public DiskFileItem setCharsetDefault(final Charset charset) {
charsetDefault = charset;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public DiskFileItemFactory get() {
* Sets the tracker, which is responsible for deleting temporary files.
*
* @param fileCleaningTracker Callback to track files created, or null (default) to disable tracking.
* @return this
* @return {@code this} instance.
*/
public Builder setFileCleaningTracker(final FileCleaningTracker fileCleaningTracker) {
this.fileCleaningTracker = fileCleaningTracker;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public interface FileItem<F extends FileItem<F>> extends FileItemHeadersProvider
* Deletes the underlying storage for a file item, including deleting any associated temporary disk file. Use this method to ensure that this is done at an
* earlier time, to preserve resources.
*
* @return this
* @return {@code this} instance.
* @throws IOException if an error occurs.
*/
F delete() throws IOException;
Expand Down Expand Up @@ -148,15 +148,15 @@ public interface FileItem<F extends FileItem<F>> extends FileItemHeadersProvider
* Sets the field name used to reference this file item.
*
* @param name The name of the form field.
* @return this
* @return {@code this} instance.
*/
F setFieldName(String name);

/**
* Sets whether or not a {@code FileItem} instance represents a simple form field.
*
* @param state {@code true} if the instance represents a simple form field; {@code false} if it represents an uploaded file.
* @return this
* @return {@code this} instance.
*/
F setFormField(boolean state);

Expand All @@ -173,7 +173,7 @@ public interface FileItem<F extends FileItem<F>> extends FileItemHeadersProvider
*
* @param file The {@code File} into which the uploaded item should be stored.
* @throws IOException if an error occurs.
* @return this
* @return {@code this} instance.
*/
F write(Path file) throws IOException;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public interface FileItemHeadersProvider<T extends FileItemHeadersProvider<T>> {
* the raw headers found within the item header block.
*
* @param headers the instance that holds onto the headers for this instance.
* @return this
* @return {@code this} instance.
*/
T setHeaders(FileItemHeaders headers);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public MultipartInput get() throws IOException {
* Sets the boundary.
*
* @param boundary the boundary.
* @return this
* @return {@code this} instance.
*/
public Builder setBoundary(final byte[] boundary) {
this.boundary = boundary;
Expand All @@ -146,7 +146,7 @@ public Builder setBoundary(final byte[] boundary) {
* Sets the progress notifier.
*
* @param progressNotifier progress notifier..
* @return this
* @return {@code this} instance.
*/
public Builder setProgressNotifier(final ProgressNotifier progressNotifier) {
this.progressNotifier = progressNotifier;
Expand Down

0 comments on commit 70e442b

Please sign in to comment.