public final class NavArgument

NavArgument denotes an argument that is supported by a NavDestination.

A NavArgument has a type and optionally a default value, that are used to read/write it in a SavedState. It can also be nullable if the type supports it.

Summary

Nested types
public final class NavArgument.Builder

A builder for constructing NavArgument instances.

Public methods
boolean
equals(Object other)
final Object

The default value of this argument or null if it doesn't have a default value.
final @NonNull NavType<Object>

The type of this NavArgument.
int
final boolean

Used to distinguish between a default value of null and an argument without an explicit default value.
final boolean

Whether this argument allows passing a null value.
@NonNull String

Public methods

equals

public boolean equals(Object other)

getDefaultValue

Added in 1.0.0
public final Object getDefaultValue()

The default value of this argument or null if it doesn't have a default value. Use isDefaultValuePresent to distinguish between null and absence of a value.

Returns
Object

The default value assigned to this argument.

getType

Added in 1.0.0
public final @NonNull NavType<Object> getType()

The type of this NavArgument.

Returns
@NonNull NavType<Object>

the NavType object denoting the type that can be help in this argument.

hashCode

public int hashCode()

isDefaultValuePresent

Added in 1.0.0
public final boolean isDefaultValuePresent()

Used to distinguish between a default value of null and an argument without an explicit default value.

Returns
boolean

true if this argument has a default value (even if that value is set to null), false otherwise

isNullable

Added in 1.0.0
public final boolean isNullable()

Whether this argument allows passing a null value.

Returns
boolean

true if null is allowed, false otherwise

toString

public @NonNull String toString()