TypeHints

Type hints can be used to alter the default conversion rules when converting Scala instances into JSON and vice versa. Type hints must be used when converting class which is not supported by default (for instance when class is not a case class).

Example:

class DateTime(val time: Long)

val hints = new ShortTypeHints(classOf[DateTime] :: Nil) {
  override def serialize: PartialFunction[Any, JObject] = {
    case t: DateTime => JObject(JField("t", JInt(t.time)) :: Nil)
  }

  override def deserialize: PartialFunction[(String, JObject), Any] = {
    case ("DateTime", JObject(JField("t", JInt(t)) :: Nil)) => new DateTime(t.longValue)
  }
}
implicit val formats = DefaultFormats.withHints(hints)

Source: Formats.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

FullTypeHints, MappedTypeHints, NoTypeHints, ShortTypeHints

Abstract Value Members

abstract def classFor(hint: String, parent: Class[_]): Option[Class[_]]

Return type for given hint.
abstract def hintFor(clazz: Class[_]): Option[String]

Return hint for given type.
abstract val hints: List[Class[_]]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(hints: TypeHints): TypeHints

Adds the specified type hints to this type hints.
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def components: List[TypeHints]
def containsHint(clazz: Class[_]): Boolean
def deserialize: PartialFunction[(String, JObject), Any]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTypeHintField(f: JField, parent: Class[_]): Boolean
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def serialize: PartialFunction[Any, JObject]
def shouldExtractHints(clazz: Class[_]): Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def typeHintFieldName: String

The name of the field in JSON where type hints are added (jsonClass by default)
def typeHintFieldNameForClass(clazz: Class[_]): Option[String]
def typeHintFieldNameForHint(hint: String, parent: Class[_]): Option[String]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package json4s

trait TypeHints extends AnyRef

Abstract Value Members

abstract def classFor(hint: String, parent: Class[_]): Option[Class[_]]

abstract def hintFor(clazz: Class[_]): Option[String]

abstract val hints: List[Class[_]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(hints: TypeHints): TypeHints

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def components: List[TypeHints]

def containsHint(clazz: Class[_]): Boolean

def deserialize: PartialFunction[(String, JObject), Any]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isTypeHintField(f: JField, parent: Class[_]): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def serialize: PartialFunction[Any, JObject]

def shouldExtractHints(clazz: Class[_]): Boolean

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

def toString(): String

def typeHintFieldName: String

def typeHintFieldNameForClass(clazz: Class[_]): Option[String]

def typeHintFieldNameForHint(hint: String, parent: Class[_]): Option[String]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped