Class

com.rojoma.json.v3.util

InternalTag

Related Doc: package util

Permalink

case class InternalTag(fieldName: String, removeTagForSubcodec: Boolean = true) 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' com.rojoma.json.v3.codec.JsonEncodes and com.rojoma.json.v3.codec.JsonDecodes (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. InternalTag
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. TagType
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. val fieldName: String

    Permalink

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. val removeTagForSubcodec: Boolean

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  16. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TagType

Inherited from AnyRef

Inherited from Any

Ungrouped