Module tools.jackson.databind

Package tools.jackson.databind.cfg

Class GeneratorSettings

java.lang.Object

tools.jackson.databind.cfg.GeneratorSettings

All Implemented Interfaces:

Serializable

public final class GeneratorSettings
extends Object
implements Serializable

Helper class used for containing settings specifically related to (re)configuring JsonGenerator constructed for writing output.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final CharacterEscapes	characterEscapes	Caller may want to specify character escaping details, either as defaults, or on call-by-call basis.
static final GeneratorSettings	empty
protected static final GeneratorSettings	EMPTY
protected static final SerializedString	NULL_ROOT_VALUE_SEPARATOR	Also need to use a null marker for root value separator
final PrettyPrinter	prettyPrinter	To allow for dynamic enabling/disabling of pretty printing, pretty printer can be optionally configured for writer as well
final SerializableString	rootValueSeparator	Caller may want to override so-called "root value separator", String added (verbatim, with no quoting or escaping) between values in root context.
final FormatSchema	schema	When using data format that uses a schema, schema is passed to generator.

Constructor Summary

Constructors

Constructor	Description
GeneratorSettings(PrettyPrinter pp, FormatSchema sch, CharacterEscapes esc, SerializableString rootSep)

Method Summary

Modifier and Type	Method	Description
static GeneratorSettings	empty()
CharacterEscapes	getCharacterEscapes()
PrettyPrinter	getPrettyPrinter()
SerializableString	getRootValueSeparator(SerializableString defaultSep)
FormatSchema	getSchema()
boolean	hasPrettyPrinter()
GeneratorSettings	with(FormatSchema sch)
GeneratorSettings	with(CharacterEscapes esc)
GeneratorSettings	with(PrettyPrinter pp)
GeneratorSettings	withRootValueSeparator(String sep)
GeneratorSettings	withRootValueSeparator(SerializableString sep)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY

protected static final GeneratorSettings EMPTY

NULL_ROOT_VALUE_SEPARATOR

protected static final SerializedString NULL_ROOT_VALUE_SEPARATOR

Also need to use a null marker for root value separator

empty

public static final GeneratorSettings empty

prettyPrinter

public final PrettyPrinter prettyPrinter

To allow for dynamic enabling/disabling of pretty printing, pretty printer can be optionally configured for writer as well

schema

public final FormatSchema schema

When using data format that uses a schema, schema is passed to generator.

characterEscapes

public final CharacterEscapes characterEscapes

Caller may want to specify character escaping details, either as defaults, or on call-by-call basis.

rootValueSeparator

public final SerializableString rootValueSeparator

Caller may want to override so-called "root value separator", String added (verbatim, with no quoting or escaping) between values in root context. Default value is a single space character, but this is often changed to linefeed.

Constructor Details

GeneratorSettings

public GeneratorSettings(PrettyPrinter pp,
 FormatSchema sch,
 CharacterEscapes esc,
 SerializableString rootSep)

Method Details

empty

public static GeneratorSettings empty()

with

public GeneratorSettings with(PrettyPrinter pp)

with

public GeneratorSettings with(FormatSchema sch)

with

public GeneratorSettings with(CharacterEscapes esc)

withRootValueSeparator

public GeneratorSettings withRootValueSeparator(String sep)

withRootValueSeparator

public GeneratorSettings withRootValueSeparator(SerializableString sep)

getSchema

public FormatSchema getSchema()

getCharacterEscapes

public CharacterEscapes getCharacterEscapes()

getPrettyPrinter

public PrettyPrinter getPrettyPrinter()

hasPrettyPrinter

public boolean hasPrettyPrinter()

getRootValueSeparator

public SerializableString getRootValueSeparator(SerializableString defaultSep)