com.vaadin.signals.operations.

Record Class SignalOperation.Error<T>

java.lang.Object
java.lang.Record
com.vaadin.signals.operations.SignalOperation.Error<T>

Type Parameters:

T - the inherited result type which is not used for errors

All Implemented Interfaces:

SignalOperation.ResultOrError<T>

Enclosing class:

SignalOperation<T>

public static record SignalOperation.Error<T>(String reason) extends Record implements SignalOperation.ResultOrError<T>

A failed signal operation result.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Error(String reason)

    Creates an instance of a Error record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean

    Indicates whether some other object is "equal to" this one.

    final int

    Returns a hash code value for this object.

    Returns the value of the reason record component.

    boolean

    Checks whether this instance represents successfully applied signal operation.

    final String

    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

    • Error

      public Error(String reason)

      Creates an instance of a Error record class.

      Parameters:

      reason - the value for the reason record component

  • Method Details

    • successful

      public boolean successful()

      Description copied from interface: SignalOperation.ResultOrError

      Checks whether this instance represents successfully applied signal operation.

      Specified by:

      successful in interface SignalOperation.ResultOrError<T>

      Returns:

      true if the operation was successful, false if there was an error

    • 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.

    • reason

      public String reason()

      Returns the value of the reason record component.

      Returns:

      the value of the reason record component