public interface PrettyPrinter
Note: since Jackson 2.1, stateful implementations MUST implement
Instantiatable
interface,
to allow for constructing per-generation instances and avoid
state corruption.
Stateless implementations need not do this; but those are less common.
Modifier and Type | Field and Description |
---|---|
static SerializedString |
DEFAULT_ROOT_VALUE_SEPARATOR
Default String used for separating root values is single space.
|
static Separators |
DEFAULT_SEPARATORS |
Modifier and Type | Method and Description |
---|---|
void |
beforeArrayValues(JsonGenerator gen)
Method called after array start marker has been output,
and right before the first value is to be output.
|
void |
beforeObjectEntries(JsonGenerator gen)
Method called after object start marker has been output,
and right before the field name of the first entry is
to be output.
|
void |
writeArrayValueSeparator(JsonGenerator gen)
Method called after an array value has been completely
output, and before another value is to be output.
|
void |
writeEndArray(JsonGenerator gen,
int nrOfValues)
Method called after an Array value has been completely output
(minus closing bracket).
|
void |
writeEndObject(JsonGenerator gen,
int nrOfEntries)
Method called after an Object value has been completely output
(minus closing curly bracket).
|
void |
writeObjectEntrySeparator(JsonGenerator gen)
Method called after an Object entry (field:value) has been completely
output, and before another value is to be output.
|
void |
writeObjectFieldValueSeparator(JsonGenerator gen)
Method called after an object field has been output, but
before the value is output.
|
void |
writeRootValueSeparator(JsonGenerator gen)
Method called after a root-level value has been completely
output, and before another value is to be output.
|
void |
writeStartArray(JsonGenerator gen)
Method called when an Array value is to be output, before
any member/child values are output.
|
void |
writeStartObject(JsonGenerator gen)
Method called when an Object value is to be output, before
any fields are output.
|
static final Separators DEFAULT_SEPARATORS
static final SerializedString DEFAULT_ROOT_VALUE_SEPARATOR
void writeRootValueSeparator(JsonGenerator gen) throws IOException
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).
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeStartObject(JsonGenerator gen) throws IOException
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.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeEndObject(JsonGenerator gen, int nrOfEntries) throws IOException
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.
gen
- Generator used for outputnrOfEntries
- Number of direct members of the Object that
have been outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeObjectEntrySeparator(JsonGenerator gen) throws IOException
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.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeObjectFieldValueSeparator(JsonGenerator gen) throws IOException
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.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeStartArray(JsonGenerator gen) throws IOException
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.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeEndArray(JsonGenerator gen, int nrOfValues) throws IOException
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.
gen
- Generator used for outputnrOfValues
- Number of direct members of the array that
have been outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid writeArrayValueSeparator(JsonGenerator gen) throws IOException
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.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid beforeArrayValues(JsonGenerator gen) throws IOException
Default handling does not output anything, but pretty-printer is free to add any white space decoration.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layervoid beforeObjectEntries(JsonGenerator gen) throws IOException
Default handling does not output anything, but pretty-printer is free to add any white space decoration.
gen
- Generator used for outputIOException
- if there is either an underlying I/O problem or encoding
issue at format layerCopyright © 2021 JBoss by Red Hat. All rights reserved.