apollo-api/com.apollographql.apollo3.api/Optional

Optional

sealed class Optional<out V>

A sealed class that can either be Present or Absent

It provides a convenient way to distinguish the case when a value is provided explicitly and should be serialized (even if it's null) and the case where it's absent and shouldn't be serialized.

Inheritors

Present

Absent

Types

Absent

object Absent : Optional<Nothing>

Companion

object Companion

Present

data class Present<V>(val value: V) : Optional<V>

Functions

getOrElse

fun <V> Optional<V>.getOrElse(fallback: V): V

Returns the value if this Optional is Present or fallback else.

getOrNull

fun getOrNull(): V?

Returns the value if this Optional is Present or null else.

getOrThrow

fun getOrThrow(): V

Returns the value if this Optional is Present or throws MissingValueException else.

map

@ApolloExperimental

fun <V, R> Optional<V>.map(mapper: (V) -> R): Optional<R>