com.rojoma.json.v3.util

InternalTag

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. val fieldName: String

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  16. val removeTagForSubcodec: Boolean

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

    Definition Classes
    AnyRef

  18. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    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