abstract class JsonMigration extends AnyRef

Data migration of old formats to current format can be implemented in a concrete subclass or provided through the factories in JsonMigrations and configured to be used by the PlayJsonSerializer for a changed class.

It is used when deserializing data of older version than the currentVersion. You implement the transformation of the JSON structure in the transform method. If you have changed the class name you should override transformClassName and return current class name.

Source
JsonMigration.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonMigration
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JsonMigration(currentVersion: Int)
  2. new JsonMigration(currentVersion: Int, supportedForwardVersion: Int)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JsonMigration to any2stringadd[JsonMigration] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JsonMigration, B)
    Implicit
    This member is added by an implicit conversion from JsonMigration to ArrowAssoc[JsonMigration] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. val currentVersion: Int
  9. def ensuring(cond: (JsonMigration) ⇒ Boolean, msg: ⇒ Any): JsonMigration
    Implicit
    This member is added by an implicit conversion from JsonMigration to Ensuring[JsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (JsonMigration) ⇒ Boolean): JsonMigration
    Implicit
    This member is added by an implicit conversion from JsonMigration to Ensuring[JsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): JsonMigration
    Implicit
    This member is added by an implicit conversion from JsonMigration to Ensuring[JsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): JsonMigration
    Implicit
    This member is added by an implicit conversion from JsonMigration to Ensuring[JsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JsonMigration to StringFormat[JsonMigration] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. val supportedForwardVersion: Int
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def transform(fromVersion: Int, json: JsObject): JsValue

    Override to provide transformation of the old JSON structure to the new JSON structure.

    Override to provide transformation of the old JSON structure to the new JSON structure.

    fromVersion

    the version of the old data

    json

    the old JSON data

  27. def transformClassName(fromVersion: Int, className: String): String

    Override this method if you have changed the class name.

    Override this method if you have changed the class name. Return current class name.

  28. def transformValue(fromVersion: Int, json: JsValue): JsValue

    Override to provide transformation of the old JSON value to the new JSON value

    Override to provide transformation of the old JSON value to the new JSON value

    fromVersion

    the version of the old data

    json

    the old JSON data

  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def →[B](y: B): (JsonMigration, B)
    Implicit
    This member is added by an implicit conversion from JsonMigration to ArrowAssoc[JsonMigration] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from JsonMigration to any2stringadd[JsonMigration]

Inherited by implicit conversion StringFormat from JsonMigration to StringFormat[JsonMigration]

Inherited by implicit conversion Ensuring from JsonMigration to Ensuring[JsonMigration]

Inherited by implicit conversion ArrowAssoc from JsonMigration to ArrowAssoc[JsonMigration]

Ungrouped