Top Description Fields Methods
com.fasterxml.jackson.core

public Interface PrettyPrinter

Known Direct Implementers
com.fasterxml.jackson.core.util.DefaultPrettyPrinter, com.fasterxml.jackson.core.util.MinimalPrettyPrinter
Imports
java.io.IOException, com.fasterxml.jackson.core.io.SerializedString, com.fasterxml.jackson.core.util.Separators
Interface for objects that implement pretty printer functionality, such as indentation. Pretty printers are used to add white space in output JSON content, to make results more human readable. Usually this means things like adding linefeeds and indentation.

Note

since Jackson 2.1, stateful implementations MUST implement com.fasterxml.jackson.core.util.Instantiatable interface, to allow for constructing per-generation instances and avoid state corruption. Stateless implementations need not do this; but those are less common.

Field Summary

Modifier and TypeField and Description
public static final SerializedString
DEFAULT_ROOT_VALUE_SEPARATOR

Default String used for separating root values is single space.

public static final Separators
DEFAULT_SEPARATORS

Method Summary

Modifier and TypeMethod and Description
public void
beforeArrayValues(JsonGenerator
Generator used for output
gen)

Method called after array start marker has been output, and right before the first value is to be output.

public void
beforeObjectEntries(JsonGenerator
Generator used for output
gen)

Method called after object start marker has been output, and right before the field name of the first entry is to be output.

public void
writeArrayValueSeparator(JsonGenerator
Generator used for output
gen)

Method called after an array value has been completely output, and before another value is to be output.

public void
writeEndArray(JsonGenerator
Generator used for output
gen, int
Number of direct members of the array that have been output
nrOfValues)

Method called after an Array value has been completely output (minus closing bracket).

public void
writeEndObject(JsonGenerator
Generator used for output
gen, int
Number of direct members of the Object that have been output
nrOfEntries)

Method called after an Object value has been completely output (minus closing curly bracket).

public void
writeObjectEntrySeparator(JsonGenerator
Generator used for output
gen)

Method called after an Object entry (field:value) has been completely output, and before another value is to be output.

public void
writeObjectFieldValueSeparator(JsonGenerator
Generator used for output
gen)

Method called after an object field has been output, but before the value is output.

public void
writeRootValueSeparator(JsonGenerator
Generator used for output
gen)

Method called after a root-level value has been completely output, and before another value is to be output.

public void
writeStartArray(JsonGenerator
Generator used for output
gen)

Method called when an Array value is to be output, before any member/child values are output.

public void
writeStartObject(JsonGenerator
Generator used for output
gen)

Method called when an Object value is to be output, before any fields are output.

Field Detail

DEFAULT_ROOT_VALUE_SEPARATORback to summary
public static final SerializedString DEFAULT_ROOT_VALUE_SEPARATOR

Default String used for separating root values is single space.

Since
2.9
DEFAULT_SEPARATORSback to summary
public static final Separators DEFAULT_SEPARATORS
Since
2.9

Method Detail

beforeArrayValuesback to summary
public void beforeArrayValues(JsonGenerator gen) throws IOException

Method called after array start marker has been output, and right before the first value is to be output. It is not called for arrays with no values.

Default handling does not output anything, but pretty-printer is free to add any white space decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
beforeObjectEntriesback to summary
public void beforeObjectEntries(JsonGenerator gen) throws IOException

Method called after object start marker has been output, and right before the field name of the first entry is to be output. It is not called for objects without entries.

Default handling does not output anything, but pretty-printer is free to add any white space decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeArrayValueSeparatorback to summary
public void writeArrayValueSeparator(JsonGenerator gen) throws IOException

Method called after an array value has been completely output, and before another value is to be output.

Default handling (without pretty-printing) will output a single comma to separate the two. Pretty-printer is to output a comma as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeEndArrayback to summary
public void writeEndArray(JsonGenerator gen, int nrOfValues) throws IOException

Method called after an Array value has been completely output (minus closing bracket).

Default handling (without pretty-printing) will output the closing bracket. Pretty-printer is to output a bracket as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

nrOfValues:int

Number of direct members of the array that have been output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeEndObjectback to summary
public void writeEndObject(JsonGenerator gen, int nrOfEntries) throws IOException

Method called after an Object value has been completely output (minus closing curly bracket).

Default handling (without pretty-printing) will output the closing curly bracket. Pretty-printer is to output a curly bracket as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

nrOfEntries:int

Number of direct members of the Object that have been output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeObjectEntrySeparatorback to summary
public void writeObjectEntrySeparator(JsonGenerator gen) throws IOException

Method called after an Object entry (field:value) has been completely output, and before another value is to be output.

Default handling (without pretty-printing) will output a single comma to separate the two. Pretty-printer is to output a comma as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeObjectFieldValueSeparatorback to summary
public void writeObjectFieldValueSeparator(JsonGenerator gen) throws IOException

Method called after an object field has been output, but before the value is output.

Default handling (without pretty-printing) will output a single colon to separate the two. Pretty-printer is to output a colon as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeRootValueSeparatorback to summary
public void writeRootValueSeparator(JsonGenerator gen) throws IOException

Method called after a root-level value has been completely output, and before another value is to be output.

Default handling (without pretty-printing) will output a space, to allow values to be parsed correctly. Pretty-printer is to output some other suitable and nice-looking separator (tab(s), space(s), linefeed(s) or any combination thereof).

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeStartArrayback to summary
public void writeStartArray(JsonGenerator gen) throws IOException

Method called when an Array value is to be output, before any member/child values are output.

Default handling (without pretty-printing) will output the opening bracket. Pretty-printer is to output a bracket as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
writeStartObjectback to summary
public void writeStartObject(JsonGenerator gen) throws IOException

Method called when an Object value is to be output, before any fields are output.

Default handling (without pretty-printing) will output the opening curly bracket. Pretty-printer is to output a curly bracket as well, but can surround that with other (white-space) decoration.

Parameters
gen:JsonGenerator

Generator used for output

Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer