Package com.vaadin.flow.router.internal

Class NavigationRouteTarget

java.lang.Object

com.vaadin.flow.router.internal.NavigationRouteTarget

All Implemented Interfaces:

Serializable

public class NavigationRouteTarget
extends Object
implements Serializable

Contains the information resulted from searching a route target using a navigation url as input. The result of the search contains the target itself if found, and the url parameter values extracted from the input path according with the route configuration.

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NavigationRouteTarget(String path, RouteTarget routeTarget, Map<String,String> parameters)

Method Summary

Modifier and Type	Method	Description
String	getPath()	Gets the input path for the search.
RouteParameters	getRouteParameters()	Gets the route parameters for this search response.
RouteTarget	getRouteTarget()	Gets the route target.
boolean	hasTarget()	Gets whether this search result instance contains a navigation target.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

NavigationRouteTarget

public NavigationRouteTarget(String path,
 RouteTarget routeTarget,
 Map<String,String> parameters)

Method Details

hasTarget

public boolean hasTarget()

Gets whether this search result instance contains a navigation target.

Returns:

true if this search result instance contains a navigation target, otherwise false.

getPath

public String getPath()

Gets the input path for the search.

Returns:

the input path for the search.

getRouteTarget

public RouteTarget getRouteTarget()

Gets the route target.

Returns:

the route target.

getRouteParameters

public RouteParameters getRouteParameters()

Gets the route parameters for this search response.

Returns:

the route parameters for this search response.

toString

public String toString()

Overrides:

toString in class Object