Class/Object

com.rojoma.json.v3.io

PrettyJsonWriter

Related Docs: object PrettyJsonWriter | package io

Permalink

class PrettyJsonWriter extends JsonWriter

An object that will write com.rojoma.json.v3.ast.JValues in a human-friendly indented format.

The writer will try to keep as much data on a single line as possible. As a result, arrays and objects have two printing modes (selected automatically), "compact" and "indented".

In the "compact" mode, an array is stored on a single line:

[ elem1, elem2, ... ]

Similarly for objects:

{ "key1" : value1, "key2 : value2, ... }

In the "indented" mode, the delimiters appear on lines by themselves, with each element formatted on a separate line:

[
  elem1,
  elem2,
  ...
]

For objects, if a key/value pair does not fit on a single line, the value is printed on a line of its own, indented further:

{
  "key" :
    value
}

Empty arrays and objects are always represented compactly, as [] or {} respectively.

This does many small writes, so it is probably a good idea to wrap the Writer in a BufferedWriter.

Linear Supertypes
JsonWriter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PrettyJsonWriter
  2. JsonWriter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PrettyJsonWriter(output: Writer, indentation: Int = 2, leftMargin: Int = 0, targetWidth: Int = 78)

    Permalink

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def write(jobject: JValue): Unit

    Permalink

    Write one com.rojoma.json.v3.ast.JValue.

    Definition Classes
    JsonWriter
    Annotations
    @throws( classOf[java.io.IOException] )
    Exceptions thrown

    [[com.rojoma.json.v3.io.JsonInvalidFloat]] if a NaN or infinite floating-point value is written.

    `IOException` if a low-level IO exception occurs.

  21. def writeArray(elements: Seq[JValue]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PrettyJsonWriterJsonWriter
  22. def writeBoolean(b: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PrettyJsonWriterJsonWriter
  23. def writeNull(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PrettyJsonWriterJsonWriter
  24. def writeNumber(x: JNumber): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PrettyJsonWriterJsonWriter
  25. def writeObject(fields: Map[String, JValue]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PrettyJsonWriterJsonWriter
  26. def writeString(s: String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PrettyJsonWriterJsonWriter

Inherited from JsonWriter

Inherited from AnyRef

Inherited from Any

Ungrouped