Printer

A pretty-printer for JSON values.

dropNullValues: Determines if object fields with values of null are dropped from the output.
indent: The indentation to use if any format strings contain a new line.
lbraceLeft: Spaces to insert to left of a left brace.
lbraceRight: Spaces to insert to right of a left brace.
rbraceLeft: Spaces to insert to left of a right brace.
rbraceRight: Spaces to insert to right of a right brace.
lbracketLeft: Spaces to insert to left of a left bracket.
lbracketRight: Spaces to insert to right of a left bracket.
rbracketLeft: Spaces to insert to left of a right bracket.
rbracketRight: Spaces to insert to right of a right bracket.
lrbracketsEmpty: Spaces to insert for an empty array.
arrayCommaLeft: Spaces to insert to left of a comma in an array.
arrayCommaRight: Spaces to insert to right of a comma in an array.
objectCommaLeft: Spaces to insert to left of a comma in an object.
objectCommaRight: Spaces to insert to right of a comma in an object.
colonLeft: Spaces to insert to left of a colon.
colonRight: Spaces to insert to right of a colon.
reuseWriters: Determines whether the printer will reuse Appendables via thread-local storage.
predictSize: Uses an adaptive size predictor to avoid grow-and-copy steps while printing into a binary output.
escapeNonAscii: Unicode-escape any non-ASCII characters in strings.
sortKeys: Determines whether the fields should be sorted.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Printer(dropNullValues: Boolean, indent: String, lbraceLeft: String = "", lbraceRight: String = "", rbraceLeft: String = "", rbraceRight: String = "", lbracketLeft: String = "", lbracketRight: String = "", rbracketLeft: String = "", rbracketRight: String = "", lrbracketsEmpty: String = "", arrayCommaLeft: String = "", arrayCommaRight: String = "", objectCommaLeft: String = "", objectCommaRight: String = "", colonLeft: String = "", colonRight: String = "", reuseWriters: Boolean = false, predictSize: Boolean = false, escapeNonAscii: Boolean = false, sortKeys: Boolean = false)

dropNullValues
Determines if object fields with values of null are dropped from the output.
indent
The indentation to use if any format strings contain a new line.
lbraceLeft
Spaces to insert to left of a left brace.
lbraceRight
Spaces to insert to right of a left brace.
rbraceLeft
Spaces to insert to left of a right brace.
rbraceRight
Spaces to insert to right of a right brace.
lbracketLeft
Spaces to insert to left of a left bracket.
lbracketRight
Spaces to insert to right of a left bracket.
rbracketLeft
Spaces to insert to left of a right bracket.
rbracketRight
Spaces to insert to right of a right bracket.
lrbracketsEmpty
Spaces to insert for an empty array.
arrayCommaLeft
Spaces to insert to left of a comma in an array.
arrayCommaRight
Spaces to insert to right of a comma in an array.
objectCommaLeft
Spaces to insert to left of a comma in an object.
objectCommaRight
Spaces to insert to right of a comma in an object.
colonLeft
Spaces to insert to left of a colon.
colonRight
Spaces to insert to right of a colon.
reuseWriters
Determines whether the printer will reuse Appendables via thread-local storage.
predictSize
Uses an adaptive size predictor to avoid grow-and-copy steps while printing into a binary output.
escapeNonAscii
Unicode-escape any non-ASCII characters in strings.
sortKeys
Determines whether the fields should be sorted.

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val arrayCommaLeft: String

Spaces to insert to left of a comma in an array.
val arrayCommaRight: String

Spaces to insert to right of a comma in an array.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val colonLeft: String

Spaces to insert to left of a colon.
val colonRight: String

Spaces to insert to right of a colon.
val dropNullValues: Boolean

Determines if object fields with values of null are dropped from the output.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val escapeNonAscii: Boolean

Unicode-escape any non-ASCII characters in strings.
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val indent: String

The indentation to use if any format strings contain a new line.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val lbraceLeft: String

Spaces to insert to left of a left brace.
val lbraceRight: String

Spaces to insert to right of a left brace.
val lbracketLeft: String

Spaces to insert to left of a left bracket.
val lbracketRight: String

Spaces to insert to right of a left bracket.
val lrbracketsEmpty: String

Spaces to insert for an empty array.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val objectCommaLeft: String

Spaces to insert to left of a comma in an object.
val objectCommaRight: String

Spaces to insert to right of a comma in an object.
val predictSize: Boolean

Uses an adaptive size predictor to avoid grow-and-copy steps while printing into a binary output.
final def pretty(json: Json): String

Returns a string representation of a pretty-printed JSON value.
final def prettyByteBuffer(json: Json): ByteBuffer
final def prettyByteBuffer(json: Json, cs: Charset): ByteBuffer
val rbraceLeft: String

Spaces to insert to left of a right brace.
val rbraceRight: String

Spaces to insert to right of a right brace.
val rbracketLeft: String

Spaces to insert to left of a right bracket.
val rbracketRight: String

Spaces to insert to right of a right bracket.
val reuseWriters: Boolean

Determines whether the printer will reuse Appendables via thread-local storage.
val sortKeys: Boolean

Determines whether the fields should be sorted.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )
final def withSortedKeys: Printer

The same pretty-printer configuration that outputs fields in sorted order.

Related Docs: object Printer | package circe

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val arrayCommaLeft: String

val arrayCommaRight: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val colonLeft: String

val colonRight: String

val dropNullValues: Boolean

final def eq(arg0: AnyRef): Boolean

val escapeNonAscii: Boolean

def finalize(): Unit

final def getClass(): Class[_]

val indent: String

final def isInstanceOf[T0]: Boolean

val lbraceLeft: String

val lbraceRight: String

val lbracketLeft: String

val lbracketRight: String

val lrbracketsEmpty: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val objectCommaLeft: String

val objectCommaRight: String

val predictSize: Boolean

final def pretty(json: Json): String

final def prettyByteBuffer(json: Json): ByteBuffer

final def prettyByteBuffer(json: Json, cs: Charset): ByteBuffer

val rbraceLeft: String

val rbraceRight: String

val rbracketLeft: String

val rbracketRight: String

val reuseWriters: Boolean

val sortKeys: Boolean

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

final def withSortedKeys: Printer

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped