Class

com.github.plokhotnyuk.jsoniter_scala.macros

CodecMakerConfig

Related Doc: package macros

Permalink

case class CodecMakerConfig(fieldNameMapper: (String) ⇒ String = identity, adtLeafClassNameMapper: (String) ⇒ String = JsonCodecMaker.simpleClassName, discriminatorFieldName: String = "type", isStringified: Boolean = false, skipUnexpectedFields: Boolean = true) extends Annotation with StaticAnnotation with Product with Serializable

Configuration parameter for JsonCodecMaker.make() call.

fieldNameMapper

the 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

a name of discriminator field ("type" value by default)

isStringified

a flag that turn on stringification of number or boolean values of collections, options and value classes (turned off by default)

skipUnexpectedFields

a flag that turn on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)

Linear Supertypes
Serializable, Serializable, Product, Equals, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CodecMakerConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. StaticAnnotation
  7. Annotation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CodecMakerConfig(fieldNameMapper: (String) ⇒ String = identity, adtLeafClassNameMapper: (String) ⇒ String = JsonCodecMaker.simpleClassName, discriminatorFieldName: String = "type", isStringified: Boolean = false, skipUnexpectedFields: Boolean = true)

    Permalink

    fieldNameMapper

    the 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

    a name of discriminator field ("type" value by default)

    isStringified

    a flag that turn on stringification of number or boolean values of collections, options and value classes (turned off by default)

    skipUnexpectedFields

    a flag that turn on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val adtLeafClassNameMapper: (String) ⇒ String

    Permalink

    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)

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. val discriminatorFieldName: String

    Permalink

    a name of discriminator field ("type" value by default)

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. val fieldNameMapper: (String) ⇒ String

    Permalink

    the function of mapping from string of case class field name to JSON key (an identity function by default)

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. val isStringified: Boolean

    Permalink

    a flag that turn on stringification of number or boolean values of collections, options and value classes (turned off by default)

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. val skipUnexpectedFields: Boolean

    Permalink

    a flag that turn on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)

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

    Permalink
    Definition Classes
    AnyRef

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped