Parameters 2.2.2 API

All Implemented Interfaces:

kotlin.collections.Iterable
```
public final class Parameters
 implements Iterable<Pair<String, Parameters.Entry>>
                    
```
A map of generic values that can be used to pass custom data to Fetchers and Decoders.
Parameters are different from Tags as parameters are used to add extensions to ImageRequest whereas Tags are used for custom user metadata. Parameters also are not attached to any OkHttp Requests and also modify the request's memory cache key by default.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Parameters.Entry`
`public final class`	`Parameters.Builder`
`public class`	`Parameters.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`size`

Constructor Summary

Constructors
Constructor	Description
`Parameters()`

Method Summary

Modifier and Type	Method	Description
`final Integer`	`size()`
`final <T extends Any> T`	`value(String key)`	Returns the value associated with key or null if key has no mapping.
`final String`	`memoryCacheKey(String key)`	Returns the cache key associated with key or null if key has no mapping.
`final Parameters.Entry`	`entry(String key)`	Returns the entry associated with key or null if key has no mapping.
`final Boolean`	`isEmpty()`	Returns 'true' if this object has no parameters.
`final Map<String, Object>`	`values()`	Returns a map of keys to values.
`final Map<String, String>`	`memoryCacheKeys()`	Returns a map of keys to non-null memory cache keys.
`Iterator<Pair<String, Parameters.Entry>>`	`iterator()`	Returns an Iterator over the entries in the Parameters.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final Parameters.Builder`	`newBuilder()`

Methods inherited from class coil.request.Parameters
forEach, spliterator
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Parameters
```
Parameters()
```
- Method Detail
  - size
```
 final Integer size()
```
  - value
```
 final <T extends Any> T value(String key)
```
    Returns the value associated with key or null if key has no mapping.
  - memoryCacheKey
```
 final String memoryCacheKey(String key)
```
    Returns the cache key associated with key or null if key has no mapping.
  - entry
```
 final Parameters.Entry entry(String key)
```
    Returns the entry associated with key or null if key has no mapping.
  - isEmpty
```
 final Boolean isEmpty()
```
    Returns 'true' if this object has no parameters.
  - values
```
 final Map<String, Object> values()
```
    Returns a map of keys to values.
  - memoryCacheKeys
```
 final Map<String, String> memoryCacheKeys()
```
    Returns a map of keys to non-null memory cache keys. Entries with a null keys are filtered.
  - iterator
```
 Iterator<Pair<String, Parameters.Entry>> iterator()
```
    Returns an Iterator over the entries in the Parameters.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - newBuilder
```
 final Parameters.Builder newBuilder()
```