Packages

c

com.lightbend.lagom.serialization

JacksonJsonMigration

abstract class JacksonJsonMigration extends AnyRef

Data migration of old formats to current format can be implemented in a concrete subclass and configured to be used by the JacksonJsonSerializer 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.

Annotations
@deprecated
Deprecated

(Since version 1.6.0) Use akka.serialization.jackson.JacksonMigration instead

Source
JacksonJsonMigration.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JacksonJsonMigration
  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 JacksonJsonMigration()

Abstract Value Members

  1. abstract def currentVersion: Int

    Define current version.

    Define current version. The first version, when no migration was used, is always 1.

  2. abstract def transform(fromVersion: Int, json: JsonNode): JsonNode

    Implement the transformation of the old JSON structure to the new JSON structure.

    Implement the transformation of the old JSON structure to the new JSON structure. The JsonNode is mutable so you can add and remove fields, or change values. Note that you have to cast to specific sub-classes such as ObjectNode and ArrayNode to get access to mutators.

    fromVersion

    the version of the old data

    json

    the old JSON data

Concrete 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 JacksonJsonMigration to any2stringadd[JacksonJsonMigration] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JacksonJsonMigration, B)
    Implicit
    This member is added by an implicit conversion from JacksonJsonMigration to ArrowAssoc[JacksonJsonMigration] 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. def ensuring(cond: (JacksonJsonMigration) ⇒ Boolean, msg: ⇒ Any): JacksonJsonMigration
    Implicit
    This member is added by an implicit conversion from JacksonJsonMigration to Ensuring[JacksonJsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (JacksonJsonMigration) ⇒ Boolean): JacksonJsonMigration
    Implicit
    This member is added by an implicit conversion from JacksonJsonMigration to Ensuring[JacksonJsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): JacksonJsonMigration
    Implicit
    This member is added by an implicit conversion from JacksonJsonMigration to Ensuring[JacksonJsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): JacksonJsonMigration
    Implicit
    This member is added by an implicit conversion from JacksonJsonMigration to Ensuring[JacksonJsonMigration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JacksonJsonMigration to StringFormat[JacksonJsonMigration] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. 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.

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped