kotlinx-serialization-json/kotlinx.serialization.json/JsonBuilder

JsonBuilder

Builder of the Json instance provided by Json { ... } factory function:

val json = Json { // this: JsonBuilder
    encodeDefaults = true
    ignoreUnknownKeys = true
}

Properties

allowComments

@ExperimentalSerializationApi

var allowComments: Boolean

Allows parser to accept C/Java-style comments in JSON input.

allowSpecialFloatingPointValues

var allowSpecialFloatingPointValues: Boolean

Removes JSON specification restriction on special floating-point values such as NaN and Infinity and enables their serialization and deserialization as float literals without quotes. When enabling it, please ensure that the receiving party will be able to encode and decode these special values. This option affects both encoding and decoding. false by default.

allowStructuredMapKeys

var allowStructuredMapKeys: Boolean

Enables structured objects to be serialized as map keys by changing serialized form of the map from JSON object (key-value pairs) to flat array like [k1, v1, k2, v2]. false by default.

allowTrailingComma

@ExperimentalSerializationApi

var allowTrailingComma: Boolean

Allows parser to accept trailing (ending) commas in JSON objects and arrays, making inputs like [1, 2, 3,] and {"key": "value",} valid. Does not affect encoding. false by default.

classDiscriminator

var classDiscriminator: String

Name of the class descriptor property for polymorphic serialization. type by default.

classDiscriminatorMode

@ExperimentalSerializationApi

var classDiscriminatorMode: ClassDiscriminatorMode

Defines which classes and objects should have class discriminator added to the output. ClassDiscriminatorMode.POLYMORPHIC by default.

coerceInputValues

var coerceInputValues: Boolean

Enables coercing incorrect JSON values in the following cases:

decodeEnumsCaseInsensitive

@ExperimentalSerializationApi

var decodeEnumsCaseInsensitive: Boolean

Enables decoding enum values in a case-insensitive manner. Encoding is not affected by this option.

encodeDefaults

var encodeDefaults: Boolean

Specifies whether default values of Kotlin properties should be encoded. false by default.

explicitNulls

var explicitNulls: Boolean

Specifies whether null values should be encoded for nullable properties and must be present in JSON object during decoding.

ignoreUnknownKeys

var ignoreUnknownKeys: Boolean

Specifies whether encounters of unknown properties in the input JSON should be ignored instead of throwing SerializationException. false by default.

isLenient

var isLenient: Boolean

Removes JSON specification restriction (RFC-4627) and makes parser more liberal to the malformed input. In lenient mode, unquoted JSON keys and string values are allowed.

namingStrategy

@ExperimentalSerializationApi

var namingStrategy: JsonNamingStrategy?

Specifies JsonNamingStrategy that should be used for all properties in classes for serialization and deserialization.

prettyPrint

var prettyPrint: Boolean

Specifies whether resulting JSON should be pretty-printed: formatted and optimized for human readability. false by default.

prettyPrintIndent

@ExperimentalSerializationApi

var prettyPrintIndent: String

Specifies indent string to use with prettyPrint mode. Only whitespace characters are allowed: ' ', '\n', '\r' or '\t'. 4 spaces by default.

serializersModule

var serializersModule: SerializersModule

Module with contextual and polymorphic serializers to be used in the resulting Json instance.

useAlternativeNames

var useAlternativeNames: Boolean

Specifies whether Json instance makes use of JsonNames annotation.

useArrayPolymorphism

var useArrayPolymorphism: Boolean

Switches polymorphic serialization to the default array format. This is an option for legacy JSON format and should not be generally used. false by default.