Package com.vaadin.flow.component.clipboard

Record Class PasteComplete

java.lang.Object
java.lang.Record
com.vaadin.flow.component.clipboard.PasteComplete
Record Components:
pasteId - the paste sequence number that just finished delivering
receivedFiles - the number of files actually delivered for this paste; equals the PasteStart.totalFiles() value the paste started with
All Implemented Interfaces:
Serializable
public record PasteComplete(long pasteId, int receivedFiles) extends Record implements Serializable
Fired by the onComplete step of a PasteFileHandler.batch() once all expected files of a paste have been delivered to the onFile step.

"Expected" comes from the browser's Clipboard.PASTE_FILE_COUNT_HEADER value; uploads that fail in transit (network errors, rejected uploads) never arrive at the server and therefore do not count, so a paste with a lost upload never fires onComplete. Batches for different pastes are independent: a paste keeps delivering files (and eventually fires onComplete) even when a newer paste's batch has already started — the two complete on their own timelines.

onComplete reflects only the files this batch successfully received; it is not a server-side error channel. To observe per-file outcomes — including server-side processing failures — pass a custom UploadHandler (or a TransferProgressListener) to onFilePaste and react to each upload there, e.g.: 


 UploadHandler.inMemory((metadata, bytes) -> {
     // handle the bytes
 }).whenComplete(success -> {
     if (!success) {
         // handle the server-side error
     }
 });
Since:
25.2
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PasteComplete(long pasteId, int receivedFiles)
    Creates an instance of a PasteComplete record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    pasteId()
    Returns the value of the pasteId record component.
    int
    receivedFiles()
    Returns the value of the receivedFiles record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PasteComplete

      public PasteComplete(long pasteId, int receivedFiles)
      Creates an instance of a PasteComplete record class.
      Parameters:
      pasteId - the value for the pasteId record component
      receivedFiles - the value for the receivedFiles record component

  • Method Details

    • 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. All components in this record class 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.

    • pasteId

      public long pasteId()
      Returns the value of the pasteId record component.
      Returns:
      the value of the pasteId record component

    • receivedFiles

      public int receivedFiles()
      Returns the value of the receivedFiles record component.
      Returns:
      the value of the receivedFiles record component