WriterConfig

Configuration for com.github.plokhotnyuk.jsoniter_scala.core.JsonWriter that contains params for formatting of output JSON and for tuning of preferred size for internal byte buffer that is created on the writer instantiation and reused in runtime for serialization of messages using java.io.OutputStream or java.nio.DirectByteBuffer.
All configuration params already initialized to default values, but in some cases they should be altered:

turn on pretty printing by specifying of indention step that is greater than 0
turn on escaping of Unicode characters to serialize with only ASCII characters
increase preferred size of an internal byte buffer to reduce allocation rate of grown and then reduced buffers when writing to java.io.OutputStream or java.nio.DirectByteBuffer lot of large (>16Kb) scala.math.BigDecimal, scala.math.BigInt or other non escaped ASCII strings written using JsonWriter.writeNonEscapedAsciiKey or JsonWriter.writeNonEscapedAsciiVal

throwWriterExceptionWithStackTrace: a flag that allows to turn on a stack traces for debugging purposes in development
indentionStep: a size of indention for pretty-printed formatting or 0 for compact output
escapeUnicode: a flag to turn on hexadecimal escaping of all non-ASCII chars
preferredBufSize: a preferred size (in bytes) of an internal byte buffer when writing to java.io.OutputStream or java.nio.DirectByteBuffer

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new WriterConfig(throwWriterExceptionWithStackTrace: Boolean = false, indentionStep: Int = 0, escapeUnicode: Boolean = false, preferredBufSize: Int = 16384)

throwWriterExceptionWithStackTrace
a flag that allows to turn on a stack traces for debugging purposes in development
indentionStep
a size of indention for pretty-printed formatting or 0 for compact output
escapeUnicode
a flag to turn on hexadecimal escaping of all non-ASCII chars
preferredBufSize
a preferred size (in bytes) of an internal byte buffer when writing to java.io.OutputStream or java.nio.DirectByteBuffer

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

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
val escapeUnicode: Boolean

a flag to turn on hexadecimal escaping of all non-ASCII chars
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 indentionStep: Int

a size of indention for pretty-printed formatting or 0 for compact output
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val preferredBufSize: Int

a preferred size (in bytes) of an internal byte buffer when writing to java.io.OutputStream or java.nio.DirectByteBuffer
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val throwWriterExceptionWithStackTrace: Boolean

a flag that allows to turn on a stack traces for debugging purposes in development
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 core

case class WriterConfig(throwWriterExceptionWithStackTrace: Boolean = false, indentionStep: Int = 0, escapeUnicode: Boolean = false, preferredBufSize: Int = 16384) extends Product with Serializable

Instance Constructors

new WriterConfig(throwWriterExceptionWithStackTrace: Boolean = false, indentionStep: Int = 0, escapeUnicode: Boolean = false, preferredBufSize: Int = 16384)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val escapeUnicode: Boolean

def finalize(): Unit

final def getClass(): Class[_]

val indentionStep: Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val preferredBufSize: Int

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

val throwWriterExceptionWithStackTrace: Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped