NavType.SerializableType

Artifact: androidx.navigation:navigation-common

Added in 1.0.0

Kotlin |Java

android

open class NavType.SerializableType<D : Serializable> : NavType

kotlin.Any
↳	androidx.navigation.NavType
	↳	androidx.navigation.NavType.SerializableType

Known direct subclasses

NavType.EnumType

NavType.EnumType

EnumType is used for NavArguments holding enum values.

SerializableType is used for Serializable NavArguments. For handling Enums you must use EnumType instead.

Null values are supported. Default values in Navigation XML files are not supported.

See also
`NavType.EnumType`

Summary

Public constructors
`<D : Serializable> SerializableType(type: Class<D>)` Constructs a NavType that supports a given Serializable type.	android

Public functions
`open operator Boolean`	`equals(other: Any?)`	android
`open operator D?`	`get(bundle: Bundle, key: String)` Get a value of this type from the `savedState`	android
`open Int`	`hashCode()`	android
`open D`	`parseValue(value: String)`	android
`open Unit`	`put(bundle: Bundle, key: String, value: D)` Put a value of this type in the `savedState`	android

Public properties
`open String`	`name` The name of this type.	android

Inherited functions

From androidx.navigation.NavType

`open D`	`parseValue(value: String, previousValue: D)` Parse a value of this type from a String and then combine that parsed value with the given previousValue of the same type to provide a new value that contains both the new and previous value.	android
`open String`	`serializeAsValue(value: D)` Serialize a value of this NavType into a String.	android
`open String`	`toString()`	android
`open Boolean`	`valueEquals(value: D, other: D)` Compares two values of type `T` and returns true if values are equal.	android

Inherited properties

From androidx.navigation.NavType

open Boolean

isNullableAllowed

Check if an argument with this type can hold a null value.

android

Public constructors

SerializableType

android

<D : Serializable> SerializableType(type: Class<D>)

Constructs a NavType that supports a given Serializable type.

Parameters
`type: Class<D>`	class that is a subtype of Serializable

Public functions

equals

android

open operator fun equals(other: Any?): Boolean

get

android

open operator fun get(bundle: Bundle, key: String): D?

Get a value of this type from the savedState

Parameters
`bundle: Bundle`	savedState to get value from
`key: String`	savedState key

Returns
`D?`	value of this type

hashCode

android

open fun hashCode(): Int

parseValue

android

open fun parseValue(value: String): D

Throws
`UnsupportedOperationException`	since Serializables do not support default values

put

android

Added in 1.0.0

open fun put(bundle: Bundle, key: String, value: D): Unit

Put a value of this type in the savedState

Parameters
`bundle: Bundle`	savedState to put value in
`key: String`	savedState key
`value: D`	value of this type

Public properties

name

android

open val name: String

The name of this type.

This is the same value that is used in Navigation XML argType attribute.

Returns
`String`	name of this type