Trait/Object

org.json4s

Formats

Related Docs: object Formats | package json4s

Permalink

trait Formats extends Serializable

Formats to use when converting JSON. Formats are usually configured by using an implicit parameter:

implicit val formats = org.json4s.DefaultFormats

Self Type
Formats
Annotations
@implicitNotFound( ... )
Source
Formats.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Formats
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def dateFormat: DateFormat

    Permalink

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +[A](newSerializer: FieldSerializer[A]): Formats

    Permalink

    Adds a field serializer for a given type to this formats.

  4. def +(newSerializer: KeySerializer[_]): Formats

    Permalink

    Adds the specified custom key serializer to this formats.

  5. def +(newSerializer: Serializer[_]): Formats

    Permalink

    Adds the specified custom serializer to this formats.

  6. def +(newSerializer: RichSerializer[_]): Formats

    Permalink

    Adds the specified custom serializer to this formats.

  7. def +(extraHints: TypeHints): Formats

    Permalink

    Adds the specified type hints to this formats.

  8. def ++(newSerializers: Iterable[Serializer[_]]): Formats

    Permalink

    Adds the specified custom serializers to this formats.

  9. def -(serializer: Serializer[_]): Formats

    Permalink

    Removes the specified custom serializer from this formats.

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def addKeySerializers(newKeySerializers: Iterable[KeySerializer[_]]): Formats

    Permalink

    Adds the specified custom serializers to this formats.

  12. def alwaysEscapeUnicode: Boolean

    Permalink
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def companions: List[(Class[_], AnyRef)]

    Permalink
  16. def considerCompanionConstructors: Boolean

    Permalink

    Setting to false preserves library's behavior prior to 3.6, where companion object constructors were only considered when deserializing if there were no primary constructors.

    Setting to false preserves library's behavior prior to 3.6, where companion object constructors were only considered when deserializing if there were no primary constructors. Setting to true preserves the backwards-incompatible change made in 3.6 to always consider companion object constructors when deserializing (https://github.com/json4s/json4s/pull/487).

  17. def customKeySerializers: List[KeySerializer[_]]

    Permalink
  18. def customSerializers: List[Serializer[_]]

    Permalink
  19. def emptyValueStrategy: EmptyValueStrategy

    Permalink
  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  22. def extractionNullStrategy: ExtractionNullStrategy

    Permalink
  23. def fieldSerializers: List[(Class[_], FieldSerializer[_])]

    Permalink
  24. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. def nonStrict: Formats

    Permalink
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def parameterNameReader: reflect.ParameterNameReader

    Permalink

    Parameter name reading strategy.

    Parameter name reading strategy. By default 'paranamer' is used.

  33. def preservingEmptyValues: Formats

    Permalink
  34. def primitives: Set[Type]

    Permalink
  35. def richSerializers: List[RichSerializer[_]]

    Permalink
  36. def skippingEmptyValues: Formats

    Permalink
  37. def strict: Formats

    Permalink
  38. def strictArrayExtraction: Boolean

    Permalink
  39. def strictFieldDeserialization: Boolean

    Permalink
  40. def strictMapExtraction: Boolean

    Permalink
  41. def strictOptionParsing: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  43. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  44. def typeHints: TypeHints

    Permalink
  45. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def wantsBigDecimal: Boolean

    Permalink
  49. def wantsBigInt: Boolean

    Permalink
  50. def withBigDecimal: Formats

    Permalink
  51. def withBigInt: Formats

    Permalink
  52. def withCompanions(comps: (Class[_], AnyRef)*): Formats

    Permalink
  53. def withDouble: Formats

    Permalink
  54. def withEmptyValueStrategy(strategy: EmptyValueStrategy): Formats

    Permalink
  55. def withEscapeUnicode: Formats

    Permalink
  56. def withExtractionNullStrategy(strategy: ExtractionNullStrategy): Formats

    Permalink
  57. def withLong: Formats

    Permalink
  58. def withPre36DeserializationBehavior: Formats

    Permalink

    Prior to 3.6 companion object constructors were only considered when deserializing if there were no primary constructors.

    Prior to 3.6 companion object constructors were only considered when deserializing if there were no primary constructors. A backwards-incompatible change was made in 3.6 to always consider companion object constructors when deserializing (https://github.com/json4s/json4s/pull/487), and is the default setting (considerCompanionConstructors = true). This changes the setting to false to preserve pre-3.6 deserialization behavior.

  59. def withStrictArrayExtraction: Formats

    Permalink
  60. def withStrictFieldDeserialization: Formats

    Permalink
  61. def withStrictMapExtraction: Formats

    Permalink
  62. def withStrictOptionParsing: Formats

    Permalink

Deprecated Value Members

  1. def customDeserializer(implicit format: Formats): PartialFunction[(TypeInfo, JValue), Any]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.6.4) Use the internal methods in the companion object instead.

  2. def customKeyDeserializer(implicit format: Formats): PartialFunction[(TypeInfo, String), Any]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.6.4) Use the internal methods in the companion object instead.

  3. def customKeySerializer(implicit format: Formats): PartialFunction[Any, String]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.6.4) Use the internal methods in the companion object instead.

  4. def customSerializer(implicit format: Formats): PartialFunction[Any, JValue]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.6.4) Use the internal methods in the companion object instead.

  5. def disallowNull: Formats

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.7.0) Use withNullExtractionStrategy instead

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped