CodecMakerConfig

Configuration parameter for JsonCodecMaker.make() call.

BEWARE: a parameter of the make macro should not depend on code from the same compilation module where it is called. Use a separated submodule of the project to compile all such dependencies before their usage for generation of codecs.

Examples of fieldNameMapper and adtLeafClassNameMapper functions that have no dependencies in the same compilation module are: JsonCodecMaker.enforceCamelCase, JsonCodecMaker.enforce_snake_case, JsonCodecMaker.enforce-kebab-case, and JsonCodecMaker.simpleClassName. Or their composition like: s => JsonCodecMaker.enforce_snake_case(JsonCodecMaker.simpleClassName(s))

fieldNameMapper: the partial function of mapping from string of case class field name to JSON key (an identity function by default)
adtLeafClassNameMapper: the function of mapping from string of case class/object full name to string value of discriminator field (a function that truncate to simple class name by default)
discriminatorFieldName: an optional name of discriminator field, where None can be used for alternative representation of ADTs without the discriminator field (Some("type") value by default)
isStringified: a flag that turns on stringification of number or boolean values of collections, options and value classes (turned off by default)
mapAsArray: a flag that turns on serialization and parsing of maps as a JSON array (or sequences of tuples) instead of a JSON object, that allow to use 'JsonValueCodec' for encoding and decoding of keys (turned off by default)
skipUnexpectedFields: a flag that turns on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)
transientDefault: a flag that turns on skipping serialization of fields that have same values as default values defined for them in the primary constructor (turned on by default)
transientEmpty: a flag that turns on skipping serialization of fields that have empty values of arrays or collections (turned on by default)
transientNone: a flag that turns on skipping serialization of fields that have empty values of options (turned on by default)
bigDecimalPrecision: a precision in 'BigDecimal' values (34 by default)
bigDecimalScaleLimit: an exclusive limit for accepted scale in 'BigDecimal' values (6178 by default)
bigDecimalDigitsLimit: an exclusive limit for accepted number of decimal digits in 'BigDecimal' values (308 by default)
bigIntDigitsLimit: an exclusive limit for accepted number of decimal digits in 'BigInt' values (308 by default)
bitSetValueLimit: an exclusive limit for accepted numeric values in bit sets (1024 by default)
mapMaxInsertNumber: a max number of inserts into maps (1024 by default)
setMaxInsertNumber: a max number of inserts into sets excluding bit sets (1024 by default)
allowRecursiveTypes: a flag that turns on support of recursive types (turned off by default)

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new CodecMakerConfig(fieldNameMapper: PartialFunction[String, String] = JsonCodecMaker.partialIdentity, adtLeafClassNameMapper: (String) ⇒ String = JsonCodecMaker.simpleClassName, discriminatorFieldName: Option[String] = Some("type"), isStringified: Boolean = false, mapAsArray: Boolean = false, skipUnexpectedFields: Boolean = true, transientDefault: Boolean = true, transientEmpty: Boolean = true, transientNone: Boolean = true, bigDecimalPrecision: Int = 34, bigDecimalScaleLimit: Int = 6178, bigDecimalDigitsLimit: Int = 308, bigIntDigitsLimit: Int = 308, bitSetValueLimit: Int = 1024, mapMaxInsertNumber: Int = 1024, setMaxInsertNumber: Int = 1024, allowRecursiveTypes: Boolean = false)

fieldNameMapper
the partial function of mapping from string of case class field name to JSON key (an identity function by default)
adtLeafClassNameMapper
the function of mapping from string of case class/object full name to string value of discriminator field (a function that truncate to simple class name by default)
discriminatorFieldName
an optional name of discriminator field, where None can be used for alternative representation of ADTs without the discriminator field (Some("type") value by default)
isStringified
a flag that turns on stringification of number or boolean values of collections, options and value classes (turned off by default)
mapAsArray
a flag that turns on serialization and parsing of maps as a JSON array (or sequences of tuples) instead of a JSON object, that allow to use 'JsonValueCodec' for encoding and decoding of keys (turned off by default)
skipUnexpectedFields
a flag that turns on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)
transientDefault
a flag that turns on skipping serialization of fields that have same values as default values defined for them in the primary constructor (turned on by default)
transientEmpty
a flag that turns on skipping serialization of fields that have empty values of arrays or collections (turned on by default)
transientNone
a flag that turns on skipping serialization of fields that have empty values of options (turned on by default)
bigDecimalPrecision
a precision in 'BigDecimal' values (34 by default)
bigDecimalScaleLimit
an exclusive limit for accepted scale in 'BigDecimal' values (6178 by default)
bigDecimalDigitsLimit
an exclusive limit for accepted number of decimal digits in 'BigDecimal' values (308 by default)
bigIntDigitsLimit
an exclusive limit for accepted number of decimal digits in 'BigInt' values (308 by default)
bitSetValueLimit
an exclusive limit for accepted numeric values in bit sets (1024 by default)
mapMaxInsertNumber
a max number of inserts into maps (1024 by default)
setMaxInsertNumber
a max number of inserts into sets excluding bit sets (1024 by default)
allowRecursiveTypes
a flag that turns on support of recursive types (turned off by default)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val adtLeafClassNameMapper: (String) ⇒ String

the function of mapping from string of case class/object full name to string value of discriminator field (a function that truncate to simple class name by default)
val allowRecursiveTypes: Boolean

a flag that turns on support of recursive types (turned off by default)
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bigDecimalDigitsLimit: Int

an exclusive limit for accepted number of decimal digits in 'BigDecimal' values (308 by default)
val bigDecimalPrecision: Int

a precision in 'BigDecimal' values (34 by default)
val bigDecimalScaleLimit: Int

an exclusive limit for accepted scale in 'BigDecimal' values (6178 by default)
val bigIntDigitsLimit: Int

an exclusive limit for accepted number of decimal digits in 'BigInt' values (308 by default)
val bitSetValueLimit: Int

an exclusive limit for accepted numeric values in bit sets (1024 by default)
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val discriminatorFieldName: Option[String]

an optional name of discriminator field, where None can be used for alternative representation of ADTs without the discriminator field (Some("type") value by default)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val fieldNameMapper: PartialFunction[String, String]

the partial function of mapping from string of case class field name to JSON key (an identity function by default)
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isStringified: Boolean

a flag that turns on stringification of number or boolean values of collections, options and value classes (turned off by default)
val mapAsArray: Boolean

a flag that turns on serialization and parsing of maps as a JSON array (or sequences of tuples) instead of a JSON object, that allow to use 'JsonValueCodec' for encoding and decoding of keys (turned off by default)
val mapMaxInsertNumber: Int

a max number of inserts into maps (1024 by default)
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val setMaxInsertNumber: Int

a max number of inserts into sets excluding bit sets (1024 by default)
val skipUnexpectedFields: Boolean

a flag that turns on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val transientDefault: Boolean

a flag that turns on skipping serialization of fields that have same values as default values defined for them in the primary constructor (turned on by default)
val transientEmpty: Boolean

a flag that turns on skipping serialization of fields that have empty values of arrays or collections (turned on by default)
val transientNone: Boolean

a flag that turns on skipping serialization of fields that have empty values of options (turned on by default)
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package macros

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val adtLeafClassNameMapper: (String) ⇒ String

val allowRecursiveTypes: Boolean

final def asInstanceOf[T0]: T0

val bigDecimalDigitsLimit: Int

val bigDecimalPrecision: Int

val bigDecimalScaleLimit: Int

val bigIntDigitsLimit: Int

val bitSetValueLimit: Int

def clone(): AnyRef

val discriminatorFieldName: Option[String]

final def eq(arg0: AnyRef): Boolean

val fieldNameMapper: PartialFunction[String, String]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val isStringified: Boolean

val mapAsArray: Boolean

val mapMaxInsertNumber: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val setMaxInsertNumber: Int

val skipUnexpectedFields: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

val transientDefault: Boolean

val transientEmpty: Boolean

val transientNone: Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped