Package com.vaadin.flow.router

Record Class PageTitleContext

java.lang.Object

java.lang.Record

com.vaadin.flow.router.PageTitleContext

Record Components:

navigationTarget - the navigation target class the title is resolved for

routeParameters - the route parameters the navigation target is resolved with; RouteParameters.empty() when no parameters are available (for example when resolving menu titles)

queryParameters - the query parameters the navigation target is resolved with; QueryParameters.empty() when not available

value - the PageTitle.value() declared on the route, or an empty string when none is declared

All Implemented Interfaces:

Serializable

public record PageTitleContext(Class<? extends Component> navigationTarget, RouteParameters routeParameters, QueryParameters queryParameters, String value)
extends Record
implements Serializable

The context handed to a PageTitleGenerator when resolving a navigation target title without an instance.

It exposes the navigation target class, the RouteParameters and QueryParameters the target would be navigated to with, and the PageTitle.value() declared on the route. That is everything an instance-free title resolver needs to compute a meaningful title, either by inspecting the parameters (for example to look up a domain object by an id) or by treating value() as a key to resolve (for example an i18n key resolved by a single application-wide generator).

Since:

25.2

Author:

Vaadin Ltd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PageTitleContext(Class<? extends Component> navigationTarget, RouteParameters routeParameters, QueryParameters queryParameters, String value)	Creates an instance of a PageTitleContext 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.
Class<? extends Component>	navigationTarget()	Returns the value of the navigationTarget record component.
QueryParameters	queryParameters()	Returns the value of the queryParameters record component.
RouteParameters	routeParameters()	Returns the value of the routeParameters record component.
final String	toString()	Returns a string representation of this record class.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PageTitleContext

public PageTitleContext(Class<? extends Component> navigationTarget,
 RouteParameters routeParameters,
 QueryParameters queryParameters,
 String value)

Creates an instance of a PageTitleContext record class.

Parameters:

navigationTarget - the value for the navigationTarget record component

routeParameters - the value for the routeParameters record component

queryParameters - the value for the queryParameters record component

value - the value for the value 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.

navigationTarget

public Class<? extends Component> navigationTarget()

Returns the value of the navigationTarget record component.

Returns:

the value of the navigationTarget record component

routeParameters

public RouteParameters routeParameters()

Returns the value of the routeParameters record component.

Returns:

the value of the routeParameters record component

queryParameters

public QueryParameters queryParameters()

Returns the value of the queryParameters record component.

Returns:

the value of the queryParameters record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component