Package com.vaadin.flow.component.trigger.internal

Record Class ClipboardPayload

java.lang.Object
java.lang.Record
com.vaadin.flow.component.trigger.internal.ClipboardPayload
Record Components:
text - text/plain contents, or null if not present
html - text/html contents, or null if not present
All Implemented Interfaces:
Serializable
public record ClipboardPayload(@Nullable String text, @Nullable String html) extends Record implements Serializable
Textual clipboard contents delivered to ReadFromClipboardAction's handler. Either field may be null if the corresponding MIME type was not present on the clipboard item.

For internal use only. May be renamed or removed in a future release.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClipboardPayload(@Nullable String text, @Nullable String html)
    Creates an instance of a ClipboardPayload 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.
    @Nullable String
    html()
    Returns the value of the html record component.
    @Nullable String
    text()
    Returns the value of the text 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

    • ClipboardPayload

      public ClipboardPayload(@Nullable String text, @Nullable String html)
      Creates an instance of a ClipboardPayload record class.
      Parameters:
      text - the value for the text record component
      html - the value for the html 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 Objects::equals(Object,Object).
      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.

    • text

      public @Nullable String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • html

      public @Nullable String html()
      Returns the value of the html record component.
      Returns:
      the value of the html record component