platform_framework_api_common_parcelable/com.tomtom.ivi.platform.framework.api.common.parcelable

Package-level declarations

This package contains utilities to serialize various types to Android's Parcel type.

Types

MarshalledTraceEvent

@IviExperimental(reasons = [])

class MarshalledTraceEvent : Parcelable

A marshalled ParcelableTraceEvent.

ParcelableBooleanList

data class ParcelableBooleanList(val value: List<Boolean>) : Parcelable

Optimized parcelable wrapper for a list of booleans, suitable for Binder transactions.

ParcelableDoubleList

data class ParcelableDoubleList(val value: List<Double>) : Parcelable

Optimized parcelable wrapper for a list of doubles, suitable for Binder transactions.

ParcelableEnum

data class ParcelableEnum(className: String, ordinal: Int) : Parcelable

A Parcelable wrapper for enums, suitable for Binder transactions.

ParcelableException

@IviInternal

data class ParcelableException : Parcelable

A parcelable variant of an Exception.

ParcelableFloatList

data class ParcelableFloatList(val value: List<Float>) : Parcelable

Optimized parcelable wrapper for a list of floats, suitable for Binder transactions.

ParcelableIntList

data class ParcelableIntList(val value: List<Int>) : Parcelable

Optimized parcelable wrapper for a list of integers, suitable for Binder transactions.

ParcelableLongList

data class ParcelableLongList(val value: List<Long>) : Parcelable

Optimized parcelable wrapper for a list of longs, suitable for Binder transactions.

ParcelableStringList

data class ParcelableStringList(val value: List<String>) : Parcelable

Optimized parcelable wrapper for a list of strings, suitable for Binder transactions.

ParcelableTraceEvent

@IviExperimental(reasons = [])

data class ParcelableTraceEvent(val traceEvent: TraceEvent, val allArgumentsSupported: Boolean) : Parcelable

Parcelable TraceEvent.

Functions

createEnumSetOptimized

@IviInternal

inline fun <T : Enum<T>> Parcel.createEnumSetOptimized(elementReader: (Parcel) -> T): EnumSet<T>?

Creates and reads an EnumSet set with element type T from a Parcel, by invoking elementReader on each element of the EnumSet.

createListOptimized

@IviInternal

inline fun <T> Parcel.createListOptimized(elementReader: (Parcel) -> T): List<T>?

Creates and reads a list of elements of type T from a Parcel, by invoking elementReader on each element in the List.

createMapOptimized

@IviInternal

inline fun <K, V> Parcel.createMapOptimized(entryReader: (Parcel) -> Pair<K, V>): Map<K, V>?

Creates and reads a map with key type K and value type V from a Parcel using entryReader.

createSetOptimized

@IviInternal

inline fun <T> Parcel.createSetOptimized(elementReader: (Parcel) -> T): Set<T>?

Creates and reads a set with element type T from a Parcel, by invoking elementReader on each element in the Set.

createSparseArrayOptimized

@IviInternal

inline fun <T> Parcel.createSparseArrayOptimized(elementReader: (Parcel) -> T): SparseArray<T>?

Same as Parcel.createListOptimized except for a SparseArray.

readArrayCompat

@IviInternal

inline fun <T> Parcel.readArrayCompat(classLoader: ClassLoader?): Array<out T>?

Reads a Array of T from a Parcel. Same as Parcel.readArray, except this function also works on Android 12 and earlier.

readBooleanCompat

@IviInternal

fun Parcel.readBooleanCompat(): Boolean

Reads a Boolean from a Parcel. Same as Parcel.readBoolean, except this function also works on Android 8.1.

readNullableInt

@IviInternal

fun Parcel.readNullableInt(): Int?

Reads a nullable Int from the Parcel receiver.

readParcelableCompat

@IviInternal

inline fun <T : Parcelable> Parcel.readParcelableCompat(classLoader: ClassLoader?): T?

Reads a Parcelable from a Parcel. Same as Parcel.readParcelable, except this function also works on Android 12 and earlier.

readParcelableCustom

@IviInternal

fun <T : Parcelable, V : Parcelable> Parcel.readParcelableCustom(loader: ClassLoader?, kClass: KClass<V>): T?

Overload of Parcel.readParcelable to read Parcel objects, while allowing type flexibility.

@IviInternal

fun <T : VersionedParcelable, V : VersionedParcelable> Parcel.readParcelableCustom(loader: ClassLoader?, kClass: KClass<V>): T?

Overload of Parcel.readParcelable to read VersionedParcelable objects, while allowing type flexibility.

readSerializableCompat

@IviInternal

inline fun <T : Serializable> Parcel.readSerializableCompat(): T?

Reads a Serializable from a Parcel. Same as Parcel.readSerializable, except this function also works on Android 12 and earlier.

toMarshalled

@IviExperimental(reasons = [])

fun TraceEvent.toMarshalled(): MarshalledTraceEvent

Converts this TraceEvent to a MarshalledTraceEvent.

toParcelable

@IviExperimental(reasons = [])

fun TraceEvent.toParcelable(): ParcelableTraceEvent

Converts this TraceEvent to a ParcelableTraceEvent.

@IviInternal

fun Exception.toParcelable(): ParcelableException

Converts this Exception to a ParcelableException.

writeBooleanCompat

@IviInternal

fun Parcel.writeBooleanCompat(value: Boolean)

Writes a Boolean to a Parcel. Same as Parcel.writeBoolean, except this function also works on Android 8.1.

writeCollectionOptimized

@IviInternal

inline fun <T> Parcel.writeCollectionOptimized(collection: Collection<T>?, elementWriter: (Parcel, T) -> Unit)

Optimized way to write a collection of T objects to a Parcel.

writeMapOptimized

@IviInternal

inline fun <K, V> Parcel.writeMapOptimized(map: Map<K, V>?, entryWriter: (Parcel, Map.Entry<K, V>) -> Unit)

Optimized and more feature rich way to write a map of K key-V value pairs to a Parcel.

writeNullableInt

@IviInternal

fun Parcel.writeNullableInt(value: Int?)

Writes a nullable Int to the Parcel receiver.

writeParcelableCustom

@IviInternal

fun Parcel.writeParcelableCustom(parcelable: Parcelable?, parcelableFlags: Int)

Overload of Parcel.readParcelable to read Parcel objects, while allowing type flexibility.

@IviInternal

fun Parcel.writeParcelableCustom(versionedParcelable: VersionedParcelable?, parcelableFlags: Int): Boolean

Overload of Parcel.readParcelable to read VersionedParcelable objects, while allowing type flexibility.

writeSparseArrayOptimized

@IviInternal

inline fun <T> Parcel.writeSparseArrayOptimized(sparseArray: SparseArray<T>?, elementWriter: (Parcel, T) -> Unit)

Same as Parcel.writeCollectionOptimized except for a SparseArray.

writeUnsafeArray

@IviInternal

fun Parcel.writeUnsafeArray(array: Array<Any?>?): Boolean

Writes array to the Parcel, like Parcel.writeArray. Except this function will not throw a RuntimeException when the array contains an element that is not supported by Parcel.writeValue.