spray.json.JsonFormatHints

FlatCoproductHint

class FlatCoproductHint[T] extends CoproductHint[T]

Product types are disambiguated by a {"key":"value",...}. Of course, this will fail if the product type has a field with the same name as the key. The default key is the word "type" which is a keyword in Scala so unlikely to collide with too many case classes.

This variant is most common in JSON serialisation schemes and well supported by other frameworks.

Linear Supertypes
CoproductHint[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FlatCoproductHint
  2. CoproductHint
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FlatCoproductHint(key: String)(implicit arg0: Typeable[T])

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def fieldName(orig: String): String

    Override to provide custom field naming.

    Override to provide custom field naming. Caching is recommended for performance.

    Attributes
    protected
    Definition Classes
    CoproductHint

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def read[Name <: Symbol](j: JsObject, n: Name): Option[JsObject]

    Given the JsObject for the sealed family, disambiguate and extract the JsObject associated to the Name implementation (if available) or otherwise return None.

    Given the JsObject for the sealed family, disambiguate and extract the JsObject associated to the Name implementation (if available) or otherwise return None.

    Definition Classes
    FlatCoproductHint → CoproductHint

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. def write[Name <: Symbol](j: JsObject, n: Name): JsObject

    Given the JsObject for the contained product type of Name, encode disambiguation information for later retrieval.

    Given the JsObject for the contained product type of Name, encode disambiguation information for later retrieval.

    Definition Classes
    FlatCoproductHint → CoproductHint

Inherited from CoproductHint[T]

Inherited from AnyRef

Inherited from Any

Ungrouped