trait DefaultValue[Value] extends AnyRef

Tells Chimney how to provide default value of type Value if flag allows them but field does not define it.

Annotations: @FunctionalInterface()
Since: 1.2.0
See also: https://chimney.readthedocs.io/cookbook/#custom-default-values for more details

trait OptionalValue[Optional, Value] extends AnyRef

Tells Chimney how to interact with Optional type to align its behavior with Option of Value.

Optional: type storing optional Value - has to be proper type, not higher-kinded type
Value: type of internal value (if present)

Since: 1.0.0
See also: https://chimney.readthedocs.io/cookbook/#custom-optional-types for more details

trait PartiallyBuildIterable[Collection, Item] extends AnyRef

Tells Chimney how to interact with Collection type to align its behavior with e.g.

Tells Chimney how to interact with Collection type to align its behavior with e.g. NonEmpty* collections of Items.

It's factory should perform validation of a collection once all its elements has been obtained.

Collection: type storing collection of Items - has to be proper type, not higher-kinded type
Item: type of internal items

Since: 1.0.0
See also: https://chimney.readthedocs.io/cookbook/#custom-collection-types for more details

trait PartiallyBuildMap[Mapp, Key, Value] extends PartiallyBuildIterable[Mapp, (Key, Value)]

Tells Chimney how to interact with Collection type to align its behavior with e.g.

Tells Chimney how to interact with Collection type to align its behavior with e.g. NonEmptyMap.

It's factory should perform validation of a collection once all its elements has been obtained.

Mapp: type storing collection of Key-Value pairs - has to be proper type, not higher-kinded type
Key: type of internal keys
Value: type of internal values

Since: 1.0.0
See also: https://chimney.readthedocs.io/cookbook/#custom-collection-types for more details

trait TotallyBuildIterable[Collection, Item] extends AnyRef

Tells Chimney how to interact with Collection type to align its behavior with Seq of Items.

Collection: type storing collection of Items - has to be proper type, not higher-kinded type
Item: type of internal items

Since: 1.0.0
See also: https://chimney.readthedocs.io/cookbook/#custom-collection-types for more details

trait TotallyBuildMap[Mapp, Key, Value] extends TotallyBuildIterable[Mapp, (Key, Value)]

Tells Chimney how to interact with Collection type to align its behavior with e.g.

Tells Chimney how to interact with Collection type to align its behavior with e.g. Map.

Mapp: type storing collection of Key-Value pairs - has to be proper type, not higher-kinded type
Key: type of internal keys
Value: type of internal values

Since: 1.0.0
See also: https://chimney.readthedocs.io/cookbook/#custom-collection-types for more details

Packages

integrations