Package com.vaadin.flow.router

Record Class NavigationEndedEvent.Failed

java.lang.Object
java.lang.Record
com.vaadin.flow.router.NavigationEndedEvent.Failed
Record Components:
error - the error that made the navigation fail, not null
All Implemented Interfaces:
NavigationEndedEvent.Outcome, Serializable
Enclosing class:
NavigationEndedEvent
public static record NavigationEndedEvent.Failed(Throwable error) extends Record implements NavigationEndedEvent.Outcome
The navigation failed.

In most cases Flow has shown an error view for the error, such as the "not found" view for a NotFoundException. When the navigation throws instead, for example because there is no error view for the exception, the error is reported here and then thrown on.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Failed(Throwable error)
    Creates a new outcome.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Throwable
    error()
    Returns the value of the error record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    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

    • Failed

      public Failed(Throwable error)
      Creates a new outcome.
      Parameters:
      error - the error that made the navigation fail, not null

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

    • error

      public Throwable error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component