Package com.vaadin.flow.component.clipboard

Record Class ClipboardFileInfo

java.lang.Object
java.lang.Record
com.vaadin.flow.component.clipboard.ClipboardFileInfo
Record Components:
name - the file name as reported by the browser; never null but may be empty for files without a name
mimeType - the MIME type as reported by the browser; never null but may be empty if the browser did not provide one
size - the file size in bytes, or 0 if the browser did not report a size
All Implemented Interfaces:
Serializable
public record ClipboardFileInfo(String name, String mimeType, long size) extends Record implements Serializable
Metadata about a file attached to a paste event — name, MIME type, and size — without the file content. Reported by the ClipboardPasteStartEvent that fires before uploads begin and by ClipboardPasteFailedEvent that fires when an upload fails.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClipboardFileInfo(String name, String mimeType, long size)
    Creates an instance of a ClipboardFileInfo 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.
    String
    mimeType()
    Returns the value of the mimeType record component.
    String
    name()
    Returns the value of the name record component.
    long
    size()
    Returns the value of the size 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

    • ClipboardFileInfo

      public ClipboardFileInfo(String name, String mimeType, long size)
      Creates an instance of a ClipboardFileInfo record class.
      Parameters:
      name - the value for the name record component
      mimeType - the value for the mimeType record component
      size - the value for the size 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. 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • mimeType

      public String mimeType()
      Returns the value of the mimeType record component.
      Returns:
      the value of the mimeType record component

    • size

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