Parameters

class Parameters : Iterable<Pair<String, Parameters.Entry>>

A map of generic values that can be used to pass custom data to Fetchers and Decoders.

Constructors

Parameters

fun Parameters()

Types

Builder

class Builder

Companion

object Companion

Entry

data class Entry(value: Any?, cacheKey: String?)

Functions

cacheKey

fun cacheKey(key: String): String?

Returns the cache key associated with key or null if key has no mapping.

cacheKeys

fun cacheKeys(): Map<String, String>

Returns a map of keys to non null cache keys. Parameters with a null cache key are filtered out.

entry

fun entry(key: String): Parameters.Entry?

Returns the entry associated with key or null if key has no mapping.

equals

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

forEach

open fun forEach(p0: Consumer<in Pair<String, Parameters.Entry>>)

hashCode

open override fun hashCode(): Int

isEmpty

fun isEmpty(): Boolean

Returns true if this object has no parameters.

iterator

open operator override fun iterator(): Iterator<Pair<String, Parameters.Entry>>

Returns an Iterator over the entries in the Parameters.

newBuilder

fun newBuilder(): Parameters.Builder

spliterator

open fun spliterator(): Spliterator<Pair<String, Parameters.Entry>>

toString

open override fun toString(): String

value

fun value(key: String): Any?

Returns the value associated with key or null if key has no mapping.

values

fun values(): Map<String, Any?>

Returns a map of keys to values.

Properties

size

@get:JvmName(name = "size")

val size: Int

Returns the number of parameters in this object.

Extensions

count

inline fun Parameters.count(): Int

Returns the number of parameters in this object.

get

inline operator fun Parameters.get(key: String): Any?

Returns the value associated with key or null if key has no mapping.

isNotEmpty

inline fun Parameters.isNotEmpty(): Boolean

Return true when the set contains elements.