FragmentNavigator.Destination

@NavDestination.ClassType(value = Fragment)
public class FragmentNavigator.Destination extends NavDestination

java.lang.Object
   ↳ androidx.navigation.NavDestination
     ↳ androidx.navigation.fragment.FragmentNavigator.Destination
Known direct subclasses
DynamicFragmentNavigator.Destination

Destination for dynamic feature navigator.

NavDestination specific to FragmentNavigator

Construct a new fragment destination. This destination is not valid until you set the Fragment via setClassName.

Summary

Public constructors

Construct a new fragment destination.

Public methods
boolean
equals(Object other)
final @NonNull String

The Fragment's class name associated with this destination
int
void

Called when inflating a destination from a resource.
final @NonNull FragmentNavigator.Destination

Set the Fragment class name associated with this destination
@NonNull String

Inherited methods
From androidx.navigation.NavDestination
final void
addArgument(@NonNull String argumentName, @NonNull NavArgument argument)

Sets an argument type for an argument name
final void

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, SavedState 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>

The arguments supported by this destination.
final @IdRes int

The destination's unique ID.
final CharSequence

The descriptive label of this destination.
final @NonNull String

The name associated with this destination's Navigator.
final NavGraph

Gets the NavGraph that contains this destination.
final String

The destination's unique route.
boolean

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)

Checks the given deep link Uri, and determines whether it matches a Uri pattern added to the destination by a call to addDeepLink .
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

The descriptive label of this destination.
final void

The destination's unique route.

Public constructors

Destination

Added in 1.0.0
public Destination(
    @NonNull Navigator<@NonNull FragmentNavigator.Destination> fragmentNavigator
)
Parameters
@NonNull Navigator<@NonNull FragmentNavigator.Destination> fragmentNavigator

The FragmentNavigator which this destination will be associated with. Generally retrieved via a NavController's NavigatorProvider.getNavigator method.

Destination

Added in 1.0.0
public Destination(@NonNull NavigatorProvider navigatorProvider)

Construct a new fragment destination. This destination is not valid until you set the Fragment via setClassName.

Parameters
@NonNull NavigatorProvider navigatorProvider

The NavController which this destination will be associated with.

Public methods

equals

public boolean equals(Object other)

getClassName

Added in 1.0.0
public final @NonNull String getClassName()

The Fragment's class name associated with this destination

Throws
kotlin.IllegalStateException

when no Fragment class was set.

hashCode

public int hashCode()

onInflate

@CallSuper
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

setClassName

Added in 1.0.0
public final @NonNull FragmentNavigator.Destination setClassName(@NonNull String className)

Set the Fragment class name associated with this destination

Parameters
@NonNull String className

The class name of the Fragment to show when you navigate to this destination
Returns
@NonNull FragmentNavigator.Destination

this Destination

toString

public @NonNull String toString()