Package io.vertx.mutiny.ext.web

Class FileUpload

java.lang.Object
io.vertx.mutiny.ext.web.FileUpload
All Implemented Interfaces:
MutinyDelegate
public class FileUpload extends Object implements MutinyDelegate
Represents a file-upload from an HTTP multipart form submission.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • FileUpload

      public FileUpload(io.vertx.ext.web.FileUpload delegate)

    • FileUpload

      public FileUpload(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.FileUpload getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • name

      public String name()
      Returns:
      the name of the upload as provided in the form submission

    • uploadedFileName

      public String uploadedFileName()
      Returns:
      the actual temporary file name on the server where the file was uploaded to.

    • fileName

      public String fileName()
      Returns:
      the file name of the upload as provided in the form submission

    • size

      public long size()
      Returns:
      the size of the upload, in bytes

    • contentType

      public String contentType()
      Returns:
      the content type (MIME type) of the upload

    • contentTransferEncoding

      public String contentTransferEncoding()
      Returns:
      the content transfer encoding of the upload - this describes how the upload was encoded in the form submission.

    • charSet

      public String charSet()
      Returns:
      the charset of the upload

    • cancel

      public boolean cancel()
      Returns:
      true when the upload was cancelled, false when the upload is finished and the file is available

    • delete

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> delete()
      Delete the uploaded file on the disk.

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • deleteAndAwait

      public Void deleteAndAwait()
      Blocking variant of delete().

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      the Void instance produced by the operation.

    • deleteAndForget

      public void deleteAndForget()
      Variant of delete() that ignores the result of the operation.

      This method subscribes on the result of delete(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from delete() but you don't need to compose it with other operations.

    • newInstance

      public static FileUpload newInstance(io.vertx.ext.web.FileUpload arg)