| java.lang.Object | |
| ↳ | com.fasterxml.jackson.core.util.DefaultPrettyPrinter |
Class Overview
Default PrettyPrinter implementation that uses 2-space
indentation with platform-default linefeeds.
Usually this class is not instantiated directly, but instead
method useDefaultPrettyPrinter() is
used, which will use an instance of this class for operation.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| DefaultPrettyPrinter.FixedSpaceIndenter | This is a very simple indenter that only every adds a single space for indentation. | ||||||||||
| DefaultPrettyPrinter.Indenter | Interface that defines objects that can produce indentation used to separate object entries and array values. | ||||||||||
| DefaultPrettyPrinter.Lf2SpacesIndenter | Default linefeed-based indenter uses system-specific linefeeds and 2 spaces for indentation per level. | ||||||||||
| DefaultPrettyPrinter.NopIndenter | Dummy implementation that adds no indentation whatsoever | ||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| _arrayIndenter | By default, let's use only spaces to separate array values. | ||||||||||
| _nesting | Number of open levels of nesting. | ||||||||||
| _objectIndenter | By default, let's use linefeed-adding indenter for separate object entries. | ||||||||||
| _spacesInObjectEntries | By default we will add spaces around colons used to separate object fields and values. | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Method called after array start marker has been output,
and right before the first value is to be output.
| |||||||||||
Method called after object start marker has been output,
and right before the field name of the first entry is
to be output.
| |||||||||||
Method called to ensure that we have a non-blueprint object to use;
it is either this object (if stateless), or a newly created object
with separate state.
| |||||||||||
Method called after an array value has been completely
output, and before another value is to be output.
| |||||||||||
Method called after an Array value has been completely output
(minus closing bracket).
| |||||||||||
Method called after an Object value has been completely output
(minus closing curly bracket).
| |||||||||||
Method called after an object entry (field:value) has been completely
output, and before another value is to be output.
| |||||||||||
Method called after an object field has been output, but
before the value is output.
| |||||||||||
Method called after a root-level value has been completely
output, and before another value is to be output.
| |||||||||||
Method called when an Array value is to be output, before
any member/child values are output.
| |||||||||||
Method called when an Object value is to be output, before
any fields are output.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.fasterxml.jackson.core.PrettyPrinter
| |||||||||||
|
From interface
com.fasterxml.jackson.core.util.Instantiatable
| |||||||||||
Fields
protected DefaultPrettyPrinter.Indenter _arrayIndenter
By default, let's use only spaces to separate array values.
protected int _nesting
Number of open levels of nesting. Used to determine amount of indentation to use.
protected DefaultPrettyPrinter.Indenter _objectIndenter
By default, let's use linefeed-adding indenter for separate object entries. We'll further configure indenter to use system-specific linefeeds, and 2 spaces per level (as opposed to, say, single tabs)
protected boolean _spacesInObjectEntries
By default we will add spaces around colons used to separate object fields and values. If disabled, will not use spaces around colon.
Public Constructors
public DefaultPrettyPrinter ()
Public Methods
public void beforeArrayValues (JsonGenerator jg)
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.
public 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. 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.
public DefaultPrettyPrinter createInstance ()
Method called to ensure that we have a non-blueprint object to use; it is either this object (if stateless), or a newly created object with separate state.
public void spacesInObjectEntries (boolean b)
public void writeArrayValueSeparator (JsonGenerator jg)
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.
public void writeEndArray (JsonGenerator jg, int nrOfValues)
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
| nrOfValues | Number of direct members of the array that have been output |
|---|
public void writeEndObject (JsonGenerator jg, int nrOfEntries)
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
| nrOfEntries | Number of direct members of the array that have been output |
|---|
public void writeObjectEntrySeparator (JsonGenerator jg)
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.
public void writeObjectFieldValueSeparator (JsonGenerator jg)
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.
public void writeRootValueSeparator (JsonGenerator jg)
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).
public void writeStartArray (JsonGenerator jg)
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.
public void writeStartObject (JsonGenerator jg)
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.