dynamodb-mapper/aws.sdk.kotlin.hll.dynamodbmapper.items/HeterogeneousItemConverter/Builder

Builder

A builder for a HeterogeneousItemConverter which maps objects to type names according to their class. Obtain an instance via the HeterogeneousItemConverter(typeAttribute) { ... } factory function.

Registrations are evaluated in the order they were made and the first one which matches an object wins, regardless of whether it was registered via exactType or instanceOf. Consequently, register more specific types before less specific ones (e.g., exactType<Car> before instanceOf<Car>, and instanceOf<Car> before instanceOf<Vehicle>). Registrations which are made unreachable by an earlier registration of the same class are rejected. Registrations made unreachable by an earlier registration of a supertype cannot be detected.

Type Parameters

The common type ancestor for all types handled by the resulting converter

Functions

exactType

inline fun <S : T> exactType(typeName: String, converter: ItemConverter<S>)

Registers converter for objects whose class is exactly S (i.e., not instances of subtypes of S).

fun <S : T> exactType(typeName: String, kClass: KClass<S>, converter: ItemConverter<S>)

Registers converter for objects whose class is exactly kClass (i.e., not instances of subtypes of kClass).

instanceOf

inline fun <S : T> instanceOf(typeName: String, converter: ItemConverter<S>)

Registers converter for objects which are instances of S (i.e., objects whose class is S or any subtype of S)

fun <S : T> instanceOf(typeName: String, kClass: KClass<S>, converter: ItemConverter<S>)

Registers converter for objects which are instances of kClass (i.e., objects whose class is kClass or any subtype of kClass)