Packages

final class TypeId extends Annotation with StaticAnnotation

Annotation allowing for customizing the type id that automatically derived encoder/decoders for abstract data types produce/consume.

By default the derived encoders and decoders for ADTs serialize the short class name of an ADT instance in order to let the decoder now, which sub-type to deserialize.

This notation allows for customizing the type id that is used to identify an ADT sub-type in the encoding and offers two choices: A String or an integer number (Int/Long) value.

Relying on strings makes the serialization more descriptive but is more verbose on the wire. Relying on numbers makes the serialization very compact but less descriptive.

If necessary styles could also be mixed within a single ADT, even though this is not recommended (for consistency/clarity only, there is no technical reason).

The following example shows such an (otherwise not recommended) mixed setup for illustrating the different style of using this annotation:

sealed trait Animal
object Animal {
  @TypeId("D") // default would be "Dog", but we want sth shorter
  final case class Dog(name: String, age: Int)

  @TypeId(2)
  final case class Cat(name: String, age: Int, weight: Option[Double])

  // if no @TypeId is given, the short type name is used, in this case "Mouse"
  final case class Mouse(name: String, size: Int)
}
Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TypeId
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TypeId(value: Any)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. val value: Any
  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
    @native() @throws( ... )

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped