Top Description Fields Constructors Methods

tools.jackson.databind.cfg

public final Class GeneratorSettings

Class Inheritance

extends Object
implements Serializable

java.lang.Object
tools.jackson.databind.cfg.GeneratorSettings

All Implemented Interfaces

java.io.Serializable

Imports

tools.jackson.core.*, tools.jackson.core.io.CharacterEscapes, .SerializedString, tools.jackson.core.util.Instantiatable

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

Field Summary

Modifier and Type	Field and Description
public final CharacterEscapes	characterEscapes Caller may want to specify character escaping details, either as defaults, or on call-by-call basis.
protected static final GeneratorSettings	EMPTY
public static final GeneratorSettings	empty
protected static final SerializedString	NULL_ROOT_VALUE_SEPARATOR Also need to use a null marker for root value separator
public final PrettyPrinter	prettyPrinter To allow for dynamic enabling/disabling of pretty printing, pretty printer can be optionally configured for writer as well
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.
public final FormatSchema	schema When using data format that uses a schema, schema is passed to generator.
private static final long	serialVersionUID

Constructor Summary

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

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

characterEscapes	back to summary
public final CharacterEscapes characterEscapes Caller may want to specify character escaping details, either as defaults, or on call-by-call basis.

EMPTY	back to summary
protected static final GeneratorSettings EMPTY

empty	back to summary
public static final GeneratorSettings empty

NULL_ROOT_VALUE_SEPARATOR	back to summary
protected static final SerializedString NULL_ROOT_VALUE_SEPARATOR Also need to use a null marker for root value separator

prettyPrinter	back to summary
public final PrettyPrinter prettyPrinter To allow for dynamic enabling/disabling of pretty printing, pretty printer can be optionally configured for writer as well

rootValueSeparator	back to summary
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.

schema	back to summary
public final FormatSchema schema When using data format that uses a schema, schema is passed to generator.

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

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

Method Detail

_rootValueSeparatorAsString	back to summary
private final String _rootValueSeparatorAsString()

empty	back to summary
public static GeneratorSettings empty()

getCharacterEscapes	back to summary
public CharacterEscapes getCharacterEscapes()

getPrettyPrinter	back to summary
public PrettyPrinter getPrettyPrinter()

getRootValueSeparator	back to summary
public SerializableString getRootValueSeparator(SerializableString defaultSep)

getSchema	back to summary
public FormatSchema getSchema()

hasPrettyPrinter	back to summary
public boolean hasPrettyPrinter()

with	back to summary
public GeneratorSettings with(PrettyPrinter pp)

with	back to summary
public GeneratorSettings with(FormatSchema sch)

with	back to summary
public GeneratorSettings with(CharacterEscapes esc)

withRootValueSeparator	back to summary
public GeneratorSettings withRootValueSeparator(String sep)

withRootValueSeparator	back to summary
public GeneratorSettings withRootValueSeparator(SerializableString sep)