com.rojoma.json.util

InternalTag

case class InternalTag (fieldName: String, removeTagForSubcodec: Boolean) extends TagType with Product with Serializable

Specifies that the base codec should add (and possibly remove) an extra field to the objects generated by the subclasses' JsonCodecs (and they must be objects).

Example: 

  1. abstract class Base
case class SubclassA(name: String) extends Base
case class SubclassB(x: Int, y: Int) extends Base

implicit val aCodec = SimpleJsonCodecBuilder[SubclassA].build("name", _.name)
implicit val bCodec = SimpleJsonCodecBuilder[SubclassB].build("x", _.x, "y", _.y)

val baseCodec = SimpleHierarchyCodecBuilder[Base](InternalTag("type")).
   branch[SubclassA]("a").
   branch[SubclassB]("b").
   build

println(baseCodec.encode(SubclassA("John"))) // { "type" : "a", "name" : "John" }
println(baseCodec.encode(SubclassB(1, 2))) // { "type" : "b", "x" : 1, "y" : 2 }
Linear Supertypes
Serializable, Serializable, Product, Equals, TagType, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. InternalTag
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. TagType
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InternalTag (fieldName: String, removeTagForSubcodec: Boolean)

Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def canEqual (arg0: Any): Boolean

    Definition Classes
    InternalTag → Equals

  8. def clone (): AnyRef

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

  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  10. def equals (arg0: Any): Boolean

    Definition Classes
    InternalTag → Equals → AnyRef → Any

  11. val fieldName : String

  12. def finalize (): Unit

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

  13. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef

  14. def hashCode (): Int

    Definition Classes
    InternalTag → AnyRef → Any

  15. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  16. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  17. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  18. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  19. def productArity : Int

    Definition Classes
    InternalTag → Product

  20. def productElement (arg0: Int): Any

    Definition Classes
    InternalTag → Product

  21. def productIterator : Iterator[Any]

    Definition Classes
    Product

  22. def productPrefix : String

    Definition Classes
    InternalTag → Product

  23. val removeTagForSubcodec : Boolean

  24. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  25. def toString (): String

    Definition Classes
    InternalTag → AnyRef → Any

  26. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  28. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  29. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TagType

Inherited from AnyRef

Inherited from Any