Package com.vaadin.flow.server.streams

Record Class UploadResult

java.lang.Object
java.lang.Record
com.vaadin.flow.server.streams.UploadResult
Record Components:
success - true if the upload was successful, false otherwise
response - the response object for the upload request
exception - the exception that caused the failure, or null if successful or no exception available
acceptedFiles - list of file names that were accepted
rejectedFiles - list of rejected files with their rejection reasons
All Implemented Interfaces:
Serializable
public record UploadResult(boolean success, VaadinResponse response, Exception exception, List<String> acceptedFiles, List<UploadResult.RejectedFile> rejectedFiles) extends Record implements Serializable
Represents the result of an upload operation.

This record encapsulates the outcome of processing an upload request, including whether it was successful, the response object, any exception that may have occurred, and lists of accepted and rejected files.

See Also:

  • Constructor Details

    • UploadResult

      public UploadResult(boolean success, VaadinResponse response)
      Creates an upload result without an exception or file tracking.
      Parameters:
      success - true if the upload was successful, false otherwise
      response - the response object for the upload request

    • UploadResult

      public UploadResult(boolean success, VaadinResponse response, Exception exception)
      Creates an upload result with an exception but no file tracking.
      Parameters:
      success - true if the upload was successful, false otherwise
      response - the response object for the upload request
      exception - the exception that caused the failure

    • UploadResult

      public UploadResult(boolean success, VaadinResponse response, Exception exception, List<String> acceptedFiles, List<UploadResult.RejectedFile> rejectedFiles)
      Creates an instance of a UploadResult record class.
      Parameters:
      success - the value for the success record component
      response - the value for the response record component
      exception - the value for the exception record component
      acceptedFiles - the value for the acceptedFiles record component
      rejectedFiles - the value for the rejectedFiles record component

  • Method Details

    • allAccepted

      public boolean allAccepted()
      Checks if all files were accepted.
      Returns:
      true if there are accepted files and no rejected files

    • allRejected

      public boolean allRejected()
      Checks if all files were rejected.
      Returns:
      true if there are rejected files and no accepted files

    • hasMixed

      public boolean hasMixed()
      Checks if there is a mix of accepted and rejected files.
      Returns:
      true if there are both accepted and rejected files

    • hasFiles

      public boolean hasFiles()
      Checks if any files were processed.
      Returns:
      true if there are any accepted or rejected files

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • response

      public VaadinResponse response()
      Returns the value of the response record component.
      Returns:
      the value of the response record component

    • exception

      public Exception exception()
      Returns the value of the exception record component.
      Returns:
      the value of the exception record component

    • acceptedFiles

      public List<String> acceptedFiles()
      Returns the value of the acceptedFiles record component.
      Returns:
      the value of the acceptedFiles record component

    • rejectedFiles

      public List<UploadResult.RejectedFile> rejectedFiles()
      Returns the value of the rejectedFiles record component.
      Returns:
      the value of the rejectedFiles record component