Object

io.fintrospect.formats.json.Circe

JsonFormat

Related Doc: package Circe

Permalink

object JsonFormat extends JsonFormat[Json, Json]

Use this to parse and create JSON objects in a generic way

Definition Classes
CirceJsonLibrary
Linear Supertypes
JsonFormat[Json, Json], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonFormat
  2. JsonFormat
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Field = (String, Json)

    Permalink
    Definition Classes
    JsonFormat

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. def array(elements: Json*): Json

    Permalink

    Create a JSON array from the passed elements

    Create a JSON array from the passed elements

    Definition Classes
    JsonFormatJsonFormat
  5. def array(elements: Iterable[Json]): Json

    Permalink

    Create a JSON array from the passed elements

    Create a JSON array from the passed elements

    Definition Classes
    JsonFormatJsonFormat
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def body[R](description: Option[String] = None, example: R = null)(implicit encodec: Encoder[R], decodec: Decoder[R]): UniBody[R]

    Permalink

    Convenience method for creating Body that just use straight JSON encoding/decoding logic

  8. def bodySpec[R](description: Option[String] = None)(implicit encodec: Encoder[R], decodec: Decoder[R]): BodySpec[R]

    Permalink

    Convenience method for creating BodySpecs that just use straight JSON encoding/decoding logic

  9. def boolean(value: Boolean): Json

    Permalink

    Create a JSON boolean node

    Create a JSON boolean node

    Definition Classes
    JsonFormatJsonFormat
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def compact(node: Json): String

    Permalink

    Compact printed JSON

    Compact printed JSON

    Definition Classes
    JsonFormatJsonFormat
  12. def decode[T](in: Json)(implicit d: Decoder[T]): T

    Permalink
  13. def encode[T](in: T)(implicit e: Encoder[T]): Json

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  23. def nullNode(): Json

    Permalink

    Create a null JSON node

    Create a null JSON node

    Definition Classes
    JsonFormatJsonFormat
  24. def number(value: BigInteger): Json

    Permalink

    Create a JSON number node

    Create a JSON number node

    Definition Classes
    JsonFormatJsonFormat
  25. def number(value: Long): Json

    Permalink

    Create a JSON number node

    Create a JSON number node

    Definition Classes
    JsonFormatJsonFormat
  26. def number(value: BigDecimal): Json

    Permalink

    Create a JSON number node

    Create a JSON number node

    Definition Classes
    JsonFormatJsonFormat
  27. def number(value: Int): Json

    Permalink

    Create a JSON number node

    Create a JSON number node

    Definition Classes
    JsonFormatJsonFormat
  28. def obj(fields: Field*): Json

    Permalink

    Create a JSON object from the passed String -> Node pairs

    Create a JSON object from the passed String -> Node pairs

    Definition Classes
    JsonFormatJsonFormat
  29. def obj(fields: Iterable[Field]): Json

    Permalink

    Create a JSON object from the passed String -> Node pairs

    Create a JSON object from the passed String -> Node pairs

    Definition Classes
    JsonFormatJsonFormat
  30. def objSym(fields: (Symbol, Json)*): Json

    Permalink

    Create a JSON object from the passed Symbol -> Node pairs

    Create a JSON object from the passed Symbol -> Node pairs

    Definition Classes
    JsonFormat
  31. def parameterSpec[R](name: String, description: Option[String] = None)(implicit encodec: Encoder[R], decodec: Decoder[R]): ParameterSpec[R]

    Permalink

    Convenience method for creating ParameterSpecs that just use straight JSON encoding/decoding logic

  32. def parse(in: String): Json

    Permalink

    Attempt to parse the JSON into the root node type.

    Attempt to parse the JSON into the root node type. Implementations should throw an exception if the parsing fails, which is dealt with by the surrounding deserialisation mechanism, so you don't need to worry about having to muddy your own code with the exception handling.

    Definition Classes
    JsonFormatJsonFormat
  33. def pretty(node: Json): String

    Permalink

    Pretty printed JSON

    Pretty printed JSON

    Definition Classes
    JsonFormatJsonFormat
  34. def responseSpec[R](statusAndDescription: (Status, String), example: R)(implicit encodec: Encoder[R], decodec: Decoder[R]): ResponseSpec

    Permalink

    Convenience method for creating ResponseSpecs that just use straight JSON encoding/decoding logic for examples

  35. def string(value: String): Json

    Permalink

    Create a JSON string node

    Create a JSON string node

    Definition Classes
    JsonFormatJsonFormat
  36. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

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

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

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

Inherited from JsonFormat[Json, Json]

Inherited from AnyRef

Inherited from Any

Ungrouped