Configuration

Configuration allowing customisation of the JSON produced when encoding, or expected when decoding. Can be used with the ConfiguredJsonCodec annotation to allow customisation of the semi-automatic derivation.

transformMemberNames: Transforms the names of any case class members in the JSON allowing, for example, formatting or case changes.
transformConstructorNames: Transforms the value of any constructor names in the JSON allowing, for example, formatting or case changes.
useDefaults: Whether to allow default values as specified for any case-class members.
discriminator: Optional key name that, when given, will be used to store the name of the constructor of an ADT in a nested field with this name. If not given, the name is instead stored as a key under which the contents of the ADT are stored as an object.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Configuration(transformMemberNames: (String) ⇒ String, transformConstructorNames: (String) ⇒ String, useDefaults: Boolean, discriminator: Option[String])

transformMemberNames
Transforms the names of any case class members in the JSON allowing, for example, formatting or case changes.
transformConstructorNames
Transforms the value of any constructor names in the JSON allowing, for example, formatting or case changes.
useDefaults
Whether to allow default values as specified for any case-class members.
discriminator
Optional key name that, when given, will be used to store the name of the constructor of an ADT in a nested field with this name. If not given, the name is instead stored as a key under which the contents of the ADT are stored as an object.

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Optional key name that, when given, will be used to store the name of the constructor of an ADT in a nested field with this name.
Optional key name that, when given, will be used to store the name of the constructor of an ADT in a nested field with this name. If not given, the name is instead stored as a key under which the contents of the ADT are stored as an object.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val transformConstructorNames: (String) ⇒ String

Transforms the value of any constructor names in the JSON allowing, for example, formatting or case changes.
val transformMemberNames: (String) ⇒ String

Transforms the names of any case class members in the JSON allowing, for example, formatting or case changes.
val useDefaults: Boolean

Whether to allow default values as specified for any case-class members.
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( ... )
def withDefaults: Configuration
def withDiscriminator(discriminator: String): Configuration
def withKebabCaseConstructorNames: Configuration
def withKebabCaseMemberNames: Configuration
def withSnakeCaseConstructorNames: Configuration
def withSnakeCaseMemberNames: Configuration

Deprecated Value Members

def withSnakeCaseKeys: Configuration

Annotations
@deprecated
Deprecated
(Since version 0.9.0) Use withSnakeCaseMemberNames instead

Related Docs: object Configuration | package extras

final case class Configuration(transformMemberNames: (String) ⇒ String, transformConstructorNames: (String) ⇒ String, useDefaults: Boolean, discriminator: Option[String]) extends Product with Serializable

Instance Constructors

new Configuration(transformMemberNames: (String) ⇒ String, transformConstructorNames: (String) ⇒ String, useDefaults: Boolean, discriminator: Option[String])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val discriminator: Option[String]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val transformConstructorNames: (String) ⇒ String

val transformMemberNames: (String) ⇒ String

val useDefaults: Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withDefaults: Configuration

def withDiscriminator(discriminator: String): Configuration

def withKebabCaseConstructorNames: Configuration

def withKebabCaseMemberNames: Configuration

def withSnakeCaseConstructorNames: Configuration

def withSnakeCaseMemberNames: Configuration

Deprecated Value Members

def withSnakeCaseKeys: Configuration

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped