NavGraph

Artifact: androidx.navigation:navigation-common

Added in 1.0.0

Kotlin |Java

public class NavGraph extends NavDestination implements Iterable

java.lang.Object
↳	androidx.navigation.NavDestination
	↳	androidx.navigation.NavGraph

Known direct subclasses

DynamicGraphNavigator.DynamicNavGraph

DynamicGraphNavigator.DynamicNavGraph

The NavGraph for dynamic features.

NavGraph is a collection of NavDestination nodes fetchable by ID.

A NavGraph serves as a 'virtual' destination: while the NavGraph itself will not appear on the back stack, navigating to the NavGraph will cause the getStartDestination to be added to the back stack.

Construct a new NavGraph. This NavGraph is not valid until you add a destination and set the starting destination.

Summary

Public constructors
`NavGraph(@NonNull Navigator<@NonNull NavGraph> navGraphNavigator)`

Public methods
`final void`	`addAll(@NonNull NavGraph other)` Add all destinations from another collection to this one.
`final void`	`addDestination(@NonNull NavDestination node)` Adds a destination to this NavGraph.
`final void`	`addDestinations(@NonNull Collection<NavDestination> nodes)` Adds multiple destinations to this NavGraph.
`final void`	`addDestinations(@NonNull NavDestination... nodes)` Adds multiple destinations to this NavGraph.
`final void`	`clear()` Clear all destinations from this navigation graph.
`boolean`	`equals(Object other)`
`final NavDestination`	`<T extends Object> findNode()` Finds a destination in the collection by route from `KClass`.
`final NavDestination`	`findNode(@IdRes int resId)` Finds a destination in the collection by ID.
`final NavDestination`	`findNode(@NonNull KClass<@NonNull ?> route)` Finds a destination in the collection by route from `KClass`.
`final NavDestination`	`<T extends Object> findNode(T route)` Finds a destination in the collection by route from Object.
`final NavDestination`	`findNode(String route)` Finds a destination in the collection by route.
`final NavDestination`	`findNodeComprehensive( int resId, NavDestination lastVisited, boolean searchChildren, NavDestination matchingDest )` Searches all children and parents recursively.
`static final @NonNull NavDestination`	`findStartDestination(@NonNull NavGraph receiver)` Finds the actual start destination of the graph, handling cases where the graph's starting destination is itself a NavGraph.
`@NonNull String`	`getDisplayName()`
`final @NonNull String`	`getStartDestDisplayName()`
`final @IdRes int`	`getStartDestination()` This method is deprecated. Use getStartDestinationId instead.
`final @IdRes int`	`getStartDestinationId()` The starting destination id for this NavGraph.
`final String`	`getStartDestinationRoute()` The route for the starting destination for this NavGraph.
`int`	`hashCode()`
`final @NonNull Iterator<@NonNull NavDestination>`	`iterator()`
`void`	`onInflate(@NonNull Context context, @NonNull AttributeSet attrs)` Called when inflating a destination from a resource.
`final void`	`remove(@NonNull NavDestination node)` Remove a given destination from this NavGraph
`final void`	`<T extends Object> setStartDestination()` Sets the starting destination for this NavGraph.
`final void`	`setStartDestination(int startDestId)` Sets the starting destination for this NavGraph.
`final void`	`setStartDestination(@NonNull String startDestRoute)` Sets the starting destination for this NavGraph.
`@NonNull String`	`toString()`

Extension functions
`final boolean`	`NavGraphKt.contains(@NonNull NavGraph receiver, @IdRes int id)` Returns `true` if a destination with `id` is found in this navigation graph.
`final boolean`	`<T extends Object> NavGraphKt.contains( @NonNull NavGraph receiver, @NonNull KClass<@NonNull T> route )` Returns `true` if a destination with `route` is found in this navigation graph.
`final boolean`	`NavGraphKt.contains(@NonNull NavGraph receiver, @NonNull String route)` Returns `true` if a destination with `route` is found in this navigation graph.
`final boolean`	`<T extends Object> NavGraphKt.contains(@NonNull NavGraph receiver, @NonNull T route)` Returns `true` if a destination with `route` is found in this navigation graph.
`final @NonNull NavDestination`	`NavGraphKt.get(@NonNull NavGraph receiver, @IdRes int id)` Returns the destination with `id`.
`final @NonNull NavDestination`	`<T extends Object> NavGraphKt.get( @NonNull NavGraph receiver, @NonNull KClass<@NonNull T> route )` Returns the destination with `route` from `KClass`.
`final @NonNull NavDestination`	`NavGraphKt.get(@NonNull NavGraph receiver, @NonNull String route)` Returns the destination with `route`.
`final @NonNull NavDestination`	`<T extends Object> NavGraphKt.get(@NonNull NavGraph receiver, @NonNull T route)` Returns the destination with `route` from an Object.
`final void`	`NavGraphKt.minusAssign( @NonNull NavGraph receiver, @NonNull NavDestination node )` Removes `node` from this navigation graph.
`final void`	`NavGraphKt.plusAssign( @NonNull NavGraph receiver, @NonNull NavDestination node )` Adds a destination to this NavGraph.
`final void`	`NavGraphKt.plusAssign(@NonNull NavGraph receiver, @NonNull NavGraph other)` Add all destinations from another collection to this one.

Inherited methods

From kotlin.collections.Iterable

`void`	`forEach(@RecentlyNonNull @NonNull Consumer<@NonNull NavDestination> p0)`
`@NonNull Spliterator<@NonNull NavDestination>`	`@RecentlyNonNull spliterator()`

From androidx.navigation.NavDestination

`final void`	`addArgument(@NonNull String argumentName, @NonNull NavArgument argument)` Sets an argument type for an argument name
`final void`	`addDeepLink(@NonNull NavDeepLink navDeepLink)` Add a deep link to this destination.
`final void`	`addDeepLink(@NonNull String uriPattern)` Add a deep link to this destination.
`final String`	`fillInLabel(@NonNull Context context, Bundle bundle)` Parses a dynamic label containing arguments into a String.
`final NavAction`	`getAction(@IdRes int id)` Returns the `NavAction` for the given action ID.
`final @NonNull Map<@NonNull String, @NonNull NavArgument>`	`getArguments()` The arguments supported by this destination.
`final @IdRes int`	`getId()` The destination's unique ID.
`final CharSequence`	`getLabel()` The descriptive label of this destination.
`final @NonNull String`	`getNavigatorName()` The name associated with this destination's `Navigator`.
`final NavGraph`	`getParent()` Gets the `NavGraph` that contains this destination.
`final String`	`getRoute()` The destination's unique route.
`boolean`	`hasDeepLink(@NonNull NavUri deepLink)` Checks the given deep link `NavUri`, and determines whether it matches a Uri pattern added to the destination by a call to `addDeepLink` .
`boolean`	`hasDeepLink(@NonNull NavDeepLinkRequest deepLinkRequest)` Checks the given `NavDeepLinkRequest`, and determines whether it matches a `NavDeepLink` added to the destination by a call to `addDeepLink`.
`boolean`	`hasDeepLink(@NonNull Uri deepLink)`
`final void`	`putAction(@IdRes int actionId, @NonNull NavAction action)` Sets the `NavAction` destination for an action ID.
`final void`	`putAction(@IdRes int actionId, @IdRes int destId)` Creates a `NavAction` for the given `destId` and associates it with the `actionId`.
`final void`	`removeAction(@IdRes int actionId)` Unsets the `NavAction` for an action ID.
`final void`	`removeArgument(@NonNull String argumentName)` Unsets the argument type for an argument name.
`final void`	`setId(int id)` The destination's unique ID.
`final void`	`setLabel(CharSequence label)` The descriptive label of this destination.
`final void`	`setParent(NavGraph parent)` Gets the `NavGraph` that contains this destination.
`final void`	`setRoute(String route)` The destination's unique route.

Public constructors

Added in 1.0.0

public NavGraph(@NonNull Navigator<@NonNull NavGraph> navGraphNavigator)

Parameters
`@NonNull Navigator<@NonNull NavGraph> navGraphNavigator`	The `NavGraphNavigator` which this destination will be associated with. Generally retrieved via a `NavController`'s`NavigatorProvider.getNavigator` method.

Public methods

Added in 1.0.0

public final void addAll(@NonNull NavGraph other)

Add all destinations from another collection to this one. As each destination has at most one parent, the destinations will be removed from the given NavGraph.

Parameters
`@NonNull NavGraph other`	collection of destinations to add. All destinations will be removed from this graph after being added to this graph.

Added in 1.0.0

public final void addDestination(@NonNull NavDestination node)

Adds a destination to this NavGraph. The destination must have an NavDestination.id id} set.

The destination must not have a parent set. If the destination is already part of a navigation graph, call remove before calling this method.

Parameters
`@NonNull NavDestination node`	destination to add

Throws
`kotlin.IllegalArgumentException`	if destination does not have an id, the destination has the same id as the graph, or the destination already has a parent.

addDestinations

Added in 1.0.0

public final void addDestinations(@NonNull Collection<NavDestination> nodes)

Adds multiple destinations to this NavGraph. Each destination must have an NavDestination.id id} set.

Each destination must not have a parent set. If any destination is already part of a navigation graph, call remove before calling this method.

Parameters
`@NonNull Collection<NavDestination> nodes`	destinations to add

addDestinations

Added in 1.0.0

public final void addDestinations(@NonNull NavDestination... nodes)

Adds multiple destinations to this NavGraph. Each destination must have an NavDestination.id id} set.

Each destination must not have a parent set. If any destination is already part of a navigation graph, call remove before calling this method.

Parameters
`@NonNull NavDestination... nodes`	destinations to add

clear

Added in 1.0.0

public final void clear()

Clear all destinations from this navigation graph.

equals

public boolean equals(Object other)

findNode

public final NavDestination <T extends Object> findNode()

Finds a destination in the collection by route from KClass. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

Parameters
`<T extends Object>`	Route from a `KClass` to locate

Returns
`NavDestination`	the node with route - the node must have been created with a route from `KClass`

findNode

Added in 1.0.0

public final NavDestination findNode(@IdRes int resId)

Finds a destination in the collection by ID. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

Parameters
`@IdRes int resId`	ID to locate

Returns
`NavDestination`	the node with ID resId

findNode

Added in 2.9.6

public final NavDestination findNode(@NonNull KClass<@NonNull ?> route)

Finds a destination in the collection by route from KClass. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

Parameters
`@NonNull KClass<@NonNull ?> route`	Route from a `KClass` to locate

Returns
`NavDestination`	the node with route - the node must have been created with a route from `KClass`

findNode

Added in 2.8.0

public final NavDestination <T extends Object> findNode(T route)

Finds a destination in the collection by route from Object. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

Parameters
`T route`	Route to locate

Returns
`NavDestination`	the node with route - the node must have been created with a route from `KClass`

findNode

Added in 2.4.0

public final NavDestination findNode(String route)

Finds a destination in the collection by route. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

Parameters
`String route`	Route to locate

Returns
`NavDestination`	the node with route

public final NavDestination findNodeComprehensive(
    int resId,
    NavDestination lastVisited,
    boolean searchChildren,
    NavDestination matchingDest
)

Searches all children and parents recursively.

Does not revisit graphs (whether it's a child or parent) if it has already been visited.

Parameters
`int resId`	the `NavDestination.id`
`NavDestination lastVisited`	the previously visited node
`boolean searchChildren`	searches the graph's children for the node when true
`NavDestination matchingDest`	an optional NavDestination that the node should match with. This is because `resId` is only unique to a local graph. Nodes in sibling graphs can have the same id.

Added in 2.4.0

public static final @NonNull NavDestination findStartDestination(@NonNull NavGraph receiver)

Finds the actual start destination of the graph, handling cases where the graph's starting destination is itself a NavGraph.

Returns
`@NonNull NavDestination`	the actual startDestination of the given graph.

getDisplayName

public @NonNull String getDisplayName()

getStartDestDisplayName

public final @NonNull String getStartDestDisplayName()

getStartDestination

Added in 1.0.0

Deprecated in 2.4.0

public final @IdRes int getStartDestination()

Gets the starting destination for this NavGraph. When navigating to the NavGraph, this destination is the one the user will initially see.

Returns
`@IdRes int`	the start destination

getStartDestinationId

Added in 2.4.0

public final @IdRes int getStartDestinationId()

The starting destination id for this NavGraph. When navigating to the NavGraph, the destination represented by this id is the one the user will initially see.

getStartDestinationRoute

Added in 2.4.0

public final String getStartDestinationRoute()

The route for the starting destination for this NavGraph. When navigating to the NavGraph, the destination represented by this route is the one the user will initially see.

hashCode

public int hashCode()

iterator

Added in 1.0.0

public final @NonNull Iterator<@NonNull NavDestination> iterator()

Throws
`kotlin.NoSuchElementException`	if there no more elements

onInflate

public void onInflate(@NonNull Context context, @NonNull AttributeSet attrs)

Called when inflating a destination from a resource.

Parameters
`@NonNull Context context`	local context performing inflation
`@NonNull AttributeSet attrs`	attrs to parse during inflation

Added in 1.0.0

public final void remove(@NonNull NavDestination node)

Remove a given destination from this NavGraph

Parameters
`@NonNull NavDestination node`	the destination to remove.

setStartDestination

public final void <T extends Object> setStartDestination()

Sets the starting destination for this NavGraph.

This will override any previously set startDestinationId

Parameters
`<T extends Object>`	The route of the destination as a `KClass` to be shown when navigating to this NavGraph.

setStartDestination

Added in 1.0.0

public final void setStartDestination(int startDestId)

Sets the starting destination for this NavGraph.

This will clear any previously set startDestinationRoute.

Parameters
`int startDestId`	The id of the destination to be shown when navigating to this NavGraph.

setStartDestination

Added in 2.4.0

public final void setStartDestination(@NonNull String startDestRoute)

Sets the starting destination for this NavGraph.

This will override any previously set startDestinationId

Parameters
`@NonNull String startDestRoute`	The route of the destination to be shown when navigating to this NavGraph.

toString

public @NonNull String toString()

Extension functions

Artifact: androidx.navigation:navigation-common

View Source

public final boolean NavGraphKt.contains(@NonNull NavGraph receiver, @IdRes int id)

Returns true if a destination with id is found in this navigation graph.

Artifact: androidx.navigation:navigation-common

View Source

public final boolean <T extends Object> NavGraphKt.contains(
    @NonNull NavGraph receiver,
    @NonNull KClass<@NonNull T> route
)

Returns true if a destination with route is found in this navigation graph.

Artifact: androidx.navigation:navigation-common

View Source

public final boolean NavGraphKt.contains(@NonNull NavGraph receiver, @NonNull String route)

Returns true if a destination with route is found in this navigation graph.

Artifact: androidx.navigation:navigation-common

View Source

public final boolean <T extends Object> NavGraphKt.contains(@NonNull NavGraph receiver, @NonNull T route)

Returns true if a destination with route is found in this navigation graph.

Artifact: androidx.navigation:navigation-common

View Source

public final @NonNull NavDestination NavGraphKt.get(@NonNull NavGraph receiver, @IdRes int id)

Returns the destination with id.

Throws
`kotlin.IllegalArgumentException`	if no destination is found with that id.

Artifact: androidx.navigation:navigation-common

View Source

public final @NonNull NavDestination <T extends Object> NavGraphKt.get(
    @NonNull NavGraph receiver,
    @NonNull KClass<@NonNull T> route
)

Returns the destination with route from KClass.

Throws
`kotlin.IllegalArgumentException`	if no destination is found with that route.

Artifact: androidx.navigation:navigation-common

View Source

public final @NonNull NavDestination NavGraphKt.get(@NonNull NavGraph receiver, @NonNull String route)

Returns the destination with route.

Throws
`kotlin.IllegalArgumentException`	if no destination is found with that route.

Artifact: androidx.navigation:navigation-common

View Source

public final @NonNull NavDestination <T extends Object> NavGraphKt.get(@NonNull NavGraph receiver, @NonNull T route)

Returns the destination with route from an Object.

Throws
`kotlin.IllegalArgumentException`	if no destination is found with that route.

Artifact: androidx.navigation:navigation-common

View Source

public final void NavGraphKt.minusAssign(
    @NonNull NavGraph receiver,
    @NonNull NavDestination node
)

Removes node from this navigation graph.

Artifact: androidx.navigation:navigation-common

View Source

public final void NavGraphKt.plusAssign(
    @NonNull NavGraph receiver,
    @NonNull NavDestination node
)

Adds a destination to this NavGraph. The destination must have an id set.

The destination must not have a parent set. If the destination is already part of a NavGraph, call NavGraph.remove before calling this method.

Parameters
`@NonNull NavDestination node`	destination to add

Artifact: androidx.navigation:navigation-common

View Source

public final void NavGraphKt.plusAssign(@NonNull NavGraph receiver, @NonNull NavGraph other)

Add all destinations from another collection to this one. As each destination has at most one parent, the destinations will be removed from the given NavGraph.

Parameters
`@NonNull NavGraph other`	collection of destinations to add. All destinations will be removed from the parameter graph after being added to this graph.