Package com.vaadin.flow.router

Class ErrorNavigationEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.router.NavigationEvent

com.vaadin.flow.router.ErrorNavigationEvent

All Implemented Interfaces:

Serializable

public class ErrorNavigationEvent
extends NavigationEvent

Event object with data related to error navigation.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ErrorNavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger, ErrorParameter<?> errorParameter)	Creates a new navigation event.
ErrorNavigationEvent(Router router, Location location, UI ui, NavigationTrigger trigger, ErrorParameter<?> errorParameter, elemental.json.JsonValue state)	Creates a new navigation event.

Method Summary

Modifier and Type	Method	Description
ErrorParameter<?>	getErrorParameter()	Gets the ErrorParameter if set.

Methods inherited from class com.vaadin.flow.router.NavigationEvent

getLocation, getSource, getState, getTrigger, getUI, isForwardTo

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorNavigationEvent

public ErrorNavigationEvent(Router router,
                            Location location,
                            UI ui,
                            NavigationTrigger trigger,
                            ErrorParameter<?> errorParameter)

Creates a new navigation event.

Parameters:

router - the router handling the navigation, not null

location - the new location, not null

ui - the UI in which the navigation occurs, not null

trigger - the type of user action that triggered this navigation event, not null

errorParameter - parameter containing navigation error information

ErrorNavigationEvent

public ErrorNavigationEvent(Router router,
                            Location location,
                            UI ui,
                            NavigationTrigger trigger,
                            ErrorParameter<?> errorParameter,
                            elemental.json.JsonValue state)

Creates a new navigation event.

Parameters:

router - the router handling the navigation, not null

location - the new location, not null

ui - the UI in which the navigation occurs, not null

trigger - the type of user action that triggered this navigation event, not null

errorParameter - parameter containing navigation error information

state - includes navigation state info including for example the scroll position and the complete href of the RouterLink

Method Detail

getErrorParameter

public ErrorParameter<?> getErrorParameter()

Gets the ErrorParameter if set.

Returns:

set error parameter or null if not set