Summary: Ctors | Methods | Inherited Methods

NavGraph

Kotlin |Java

public class NavGraph
extends NavDestination implements Iterable<NavDestination>

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

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 starting destination to be added to the back stack.

Summary

Public constructors
`NavGraph(Navigator<? extends NavGraph> navGraphNavigator)` Construct a new NavGraph.

Public methods
`final void`	`addAll(NavGraph other)` Add all destinations from another collection to this one.
`final void`	`addDestination(NavDestination node)` Adds a destination to this NavGraph.
`final void`	`addDestinations(Collection<NavDestination> nodes)` Adds multiple destinations to this NavGraph.
`final void`	`addDestinations(NavDestination... nodes)` Adds multiple destinations to this NavGraph.
`final void`	`clear()` Clear all destinations from this navigation graph.
`final NavDestination`	`findNode(int resid)` Finds a destination in the collection by ID.
`final int`	`getStartDestination()` Returns the starting destination for this NavGraph.
`final Iterator<NavDestination>`	`iterator()`
`void`	`onInflate(Context context, AttributeSet attrs)` Called when inflating a destination from a resource.
`final void`	`remove(NavDestination node)` Remove a given destination from this NavGraph
`final void`	`setStartDestination(int startDestId)` Sets the starting destination for this NavGraph.
`String`	`toString()`

Inherited methods

From class


        
          androidx.navigation.NavDestination

`final void`	`addArgument(String argumentName, NavArgument argument)` Sets an argument type for an argument name
`final void`	`addDeepLink(String uriPattern)` Add a deep link to this destination.
`final void`	`addDeepLink(NavDeepLink navDeepLink)` Add a deep link to this destination.
`final NavAction`	`getAction(int id)` Returns the destination ID for a given action.
`final Map<String, NavArgument>`	`getArguments()` Get the arguments supported by this destination.
`final int`	`getId()` Returns the destination's unique ID.
`final CharSequence`	`getLabel()` Gets the descriptive label of this destination.
`final String`	`getNavigatorName()` Returns the name associated with this destination's `Navigator`.
`final NavGraph`	`getParent()` Gets the `NavGraph` that contains this destination.
`boolean`	`hasDeepLink(Uri deepLink)` Checks the given deep link `Uri`, and determines whether it matches a Uri pattern added to the destination by a call to `addDeepLink(String)` .
`boolean`	`hasDeepLink(NavDeepLinkRequest deepLinkRequest)` Checks the given `NavDeepLinkRequest`, and determines whether it matches a `NavDeepLink` added to the destination by a call to `addDeepLink(NavDeepLink)`.
`void`	`onInflate(Context context, AttributeSet attrs)` Called when inflating a destination from a resource.
`static <C> Class<? extends C>`	`parseClassFromName(Context context, String name, Class<? extends C> expectedClassType)` Parse the class associated with this destination from a raw name, generally extracted from the `android:name` attribute added to the destination's XML.
`final void`	`putAction(int actionId, NavAction action)` Sets a destination ID for an action ID.
`final void`	`putAction(int actionId, int destId)` Sets a destination ID for an action ID.
`final void`	`removeAction(int actionId)` Unsets the destination ID for an action ID.
`final void`	`removeArgument(String argumentName)` Unsets the argument type for an argument name.
`final void`	`setId(int id)` Sets the destination's unique ID.
`final void`	`setLabel(CharSequence label)` Sets the descriptive label of this destination.
`String`	`toString()`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          java.lang.Iterable

`default void`	`forEach(Consumer<? super T> arg0)`
`abstract Iterator<NavDestination>`	`iterator()`
`default Spliterator<NavDestination>`	`spliterator()`

Public constructors

public NavGraph (Navigator<? extends NavGraph> navGraphNavigator)

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

Parameters
`navGraphNavigator`	`Navigator`: The `NavGraphNavigator` which this destination will be associated with. Generally retrieved via a `NavController`'s `NavigatorProvider.getNavigator(Class)` method.

Public methods

public final void addAll (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
`other`	`NavGraph`: collection of destinations to add. All destinations will be removed from this graph after being added to this graph.

public final void addDestination (NavDestination node)

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

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

Parameters
`node`	`NavDestination`: destination to add

public final void addDestinations (Collection<NavDestination> nodes)

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

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

Parameters
`nodes`	`Collection`: destinations to add

public final void addDestinations (NavDestination... nodes)

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

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

Parameters
`nodes`	`NavDestination`: destinations to add

clear

public final void clear ()

Clear all destinations from this navigation graph.

findNode

public final NavDestination findNode (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
`resid`	`int`: ID to locate

Returns
`NavDestination`	the node with ID resid

getStartDestination

public final int getStartDestination ()

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

Returns
`int`

iterator

public final Iterator<NavDestination> iterator ()

Returns
`Iterator<NavDestination>`

onInflate

public void onInflate (Context context, 
                AttributeSet attrs)

Called when inflating a destination from a resource.

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

public final void remove (NavDestination node)

Remove a given destination from this NavGraph

Parameters
`node`	`NavDestination`: the destination to remove.

setStartDestination

public final void setStartDestination (int startDestId)

Sets the starting destination for this NavGraph.

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

toString

public String toString ()

Returns
`String`