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 (see [JACKSON-851] for details).
Stateless implementations need not do this; but those are less common.
Modifier and Type | Method and Description |
---|---|
void |
beforeArrayValues(JsonGenerator jg)
Method called after array start marker has been output,
and right before the first value is to be output.
|
void |
beforeObjectEntries(JsonGenerator jg)
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 jg)
Method called after an array value has been completely
output, and before another value is to be output.
|
void |
writeEndArray(JsonGenerator jg,
int nrOfValues)
Method called after an Array value has been completely output
(minus closing bracket).
|
void |
writeEndObject(JsonGenerator jg,
int nrOfEntries)
Method called after an Object value has been completely output
(minus closing curly bracket).
|
void |
writeObjectEntrySeparator(JsonGenerator jg)
Method called after an object entry (field:value) has been completely
output, and before another value is to be output.
|
void |
writeObjectFieldValueSeparator(JsonGenerator jg)
Method called after an object field has been output, but
before the value is output.
|
void |
writeRootValueSeparator(JsonGenerator jg)
Method called after a root-level value has been completely
output, and before another value is to be output.
|
void |
writeStartArray(JsonGenerator jg)
Method called when an Array value is to be output, before
any member/child values are output.
|
void |
writeStartObject(JsonGenerator jg)
Method called when an Object value is to be output, before
any fields are output.
|
void writeRootValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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).
IOException
JsonGenerationException
void writeStartObject(JsonGenerator jg) throws IOException, JsonGenerationException
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.
IOException
JsonGenerationException
void writeEndObject(JsonGenerator jg, int nrOfEntries) throws IOException, JsonGenerationException
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.
nrOfEntries
- Number of direct members of the array that
have been outputIOException
JsonGenerationException
void writeObjectEntrySeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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.
IOException
JsonGenerationException
void writeObjectFieldValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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.
IOException
JsonGenerationException
void writeStartArray(JsonGenerator jg) throws IOException, JsonGenerationException
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.
IOException
JsonGenerationException
void writeEndArray(JsonGenerator jg, int nrOfValues) throws IOException, JsonGenerationException
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.
nrOfValues
- Number of direct members of the array that
have been outputIOException
JsonGenerationException
void writeArrayValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
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.
IOException
JsonGenerationException
void beforeArrayValues(JsonGenerator jg) throws IOException, JsonGenerationException
Default handling does not output anything, but pretty-printer is free to add any white space decoration.
IOException
JsonGenerationException
void beforeObjectEntries(JsonGenerator jg) throws IOException, JsonGenerationException
Default handling does not output anything, but pretty-printer is free to add any white space decoration.
IOException
JsonGenerationException
Copyright © 2016 JBoss by Red Hat. All rights reserved.