TypedFormats

Formats a subclass of a variable-schema superclass.

Variable-schema objects must have a type name (string) and a definition (JSON). The schema of the definition is specified based on the type name. These formats read the type name and then appropriately handle the JSON definition.

For example, the type names for a user id object may be "guest" and "registered" and the corresponding definitions may include a random string for the guest and an integer id for the registered user.

sealed trait UserId

case class GuestUserId(id: String)

object GuestUserId {
  implicit val format: OFormat[GuestUserId] =
    TypedFormats.typedDefinitionFormat("guest", Json.format[GuestUserId])
}

case class RegisteredUserId(id: Int)

object RegisteredUserId {
  implicit val format: OFormat[RegisteredUserId] =
    TypedFormats.typedDefinitionFormat("registered", Json.format[RegisteredUserId])
}

The JSON object looks like:

{
  "typeName": "<some name>",
  "definition": &lt;some JSON&gt;
}

See OrFormats for defining UserId's OFormat in this example.

Linear Supertypes

AnyRef, Any

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( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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
def toString(): String

Definition Classes
AnyRef → Any
def typedDefinitionFormat[T, D](typeName: T, defaultFormat: Format[D])(implicit stringKeyFormat: StringKeyFormat[T]): OFormat[D]
def typedDefinitionReads[T, D](typeName: T, defaultReads: Reads[D])(implicit stringKeyFormat: StringKeyFormat[T]): Reads[D]
def typedDefinitionWrites[T, D](typeName: T, defaultWrites: Writes[D])(implicit stringKeyFormat: StringKeyFormat[T]): OWrites[D]
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 jsonformat

object TypedFormats

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

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

def toString(): String

def typedDefinitionFormat[T, D](typeName: T, defaultFormat: Format[D])(implicit stringKeyFormat: StringKeyFormat[T]): OFormat[D]

def typedDefinitionReads[T, D](typeName: T, defaultReads: Reads[D])(implicit stringKeyFormat: StringKeyFormat[T]): Reads[D]

def typedDefinitionWrites[T, D](typeName: T, defaultWrites: Writes[D])(implicit stringKeyFormat: StringKeyFormat[T]): OWrites[D]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped