Package com.vaadin.flow.component.clipboard

Record Class PasteStart

java.lang.Object
java.lang.Record
com.vaadin.flow.component.clipboard.PasteStart
Record Components:
pasteId - the paste sequence number; matches the PasteFile.pasteId() of the files about to be delivered
totalFiles - the number of files the browser said the paste contains
All Implemented Interfaces:
Serializable
public record PasteStart(long pasteId, int totalFiles) extends Record implements Serializable
Fired by the onStart step of a PasteFileHandler.session() once per paste, immediately before the paste's first PasteFile is delivered. Carries the paste correlation token and the total file count the browser declared (so a UI can show "0 / N" before any file has arrived).

The handler keeps a high-water mark of observed paste ids; an onStart fires only for the latest paste seen, so late uploads from an older paste do not regenerate a start event.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PasteStart(long pasteId, int totalFiles)
    Creates an instance of a PasteStart 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.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalFiles()
    Returns the value of the totalFiles record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PasteStart

      public PasteStart(long pasteId, int totalFiles)
      Creates an instance of a PasteStart record class.
      Parameters:
      pasteId - the value for the pasteId record component
      totalFiles - the value for the totalFiles 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

    • totalFiles

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