PrettyPrinter implementation that uses 2-space
indentation with platform-default linefeeds.
Usually this class is not instantiated directly, but instead
method JsonGenerator#useDefaultPrettyPrinter is
used, which will use an instance of this class for operation.
If you override this class, take note of Instantiatable,
as subclasses will still create an instance of DefaultPrettyPrinter.
This class is designed for the JSON data format. It works on other formats
with same logical model (such as binary CBOR and Smile formats),
but may not work as-is for other data formats, most notably XML.
It may be necessary to use format-specific PrettyPrinter
implementation specific to that format.
| Modifier and Type | Class and Description |
|---|---|
| public static class | DefaultPrettyPrinter.
This is a very simple indenter that only adds a single space for indentation. |
| public static interface | DefaultPrettyPrinter.
Interface that defines objects that can produce indentation used to separate object entries and array values. |
| public static class | DefaultPrettyPrinter.
Dummy implementation that adds no indentation whatsoever |
| Modifier and Type | Field and Description |
|---|---|
| protected String | _arrayEmptySeparator
String to use in empty Array to separate start and end markers. |
| protected DefaultPrettyPrinter. | _arrayIndenter
By default, let's use only spaces to separate array values. |
| protected String | |
| protected transient int | _nesting
Number of open levels of nesting. |
| protected String | _objectEmptySeparator
String to use in empty Object to separate start and end markers. |
| protected String | |
| protected String | |
| protected DefaultPrettyPrinter. | _objectIndenter
By default, let's use linefeed-adding indenter for separate object entries. |
| protected SerializableString | _rootSeparator
String printed between root-level values, if any. |
| protected Separators | |
| protected boolean | _spacesInObjectEntries
Deprecated
in 2.16. Use Separators API instead.
By default we will add spaces around colons used to
separate object fields and values.
|
| public static final SerializedString | DEFAULT_ROOT_VALUE_SEPARATOR
Hides com.
Deprecated
in 2.16. Use the Separators API instead.
Constant that specifies default "root-level" separator to use between
root values: a single space character.
|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | |
| public | DefaultPrettyPrinter(String
String to use as root value separator rootSeparator)
Deprecated
in 2.16. Use the Separators API instead.
Constructor that specifies separator String to use between root values; if null, no separator is printed. |
| public | DefaultPrettyPrinter(SerializableString
String to use as root value separator rootSeparator)
Deprecated
in 2.16. Use the Separators API instead.
Constructor that specifies separator String to use between root values; if null, no separator is printed. |
| public | DefaultPrettyPrinter(DefaultPrettyPrinter base, SerializableString rootSeparator)
Deprecated
in 2.16. Use the Separators API instead.
|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected DefaultPrettyPrinter | |
| public void | beforeArrayValues(JsonGenerator
Generator used for output g)Implements com. 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 g)Implements com. Method called after object start marker has been output, and right before the field name of the first entry is to be output. |
| public DefaultPrettyPrinter | createInstance()
Implements com. 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 | |
| public void | |
| public DefaultPrettyPrinter | |
| public DefaultPrettyPrinter | |
| public DefaultPrettyPrinter | Returns: This pretty-printer instance (for call chaining)
Deprecated
in 2.16. Use the Separators API instead.
"Mutant factory" method that will return a pretty printer instance that does not use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned. |
| public DefaultPrettyPrinter | withRootSeparator(SerializableString rootSeparator)
Deprecated
in 2.16. Use the Separators API instead.
|
| public DefaultPrettyPrinter | Returns: This pretty-printer instance (for call chaining)Root-level value separator to use rootSeparator)
Deprecated
in 2.16. Use the Separators API instead.
|
| public DefaultPrettyPrinter | Returns: This pretty-printer instance (for call chaining)Separator definitions to use separators)Method for configuring separators for this pretty-printer to use |
| public DefaultPrettyPrinter | Returns: This pretty-printer instance (for call chaining)
Deprecated
in 2.16. Use the Separators API instead.
"Mutant factory" method that will return a pretty printer instance that does use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned. |
| public void | writeArrayValueSeparator(JsonGenerator
Generator used for output g)Implements com. 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 g, int Number of direct members of the array that
have been output nrOfValues)Implements com. Method called after an Array value has been completely output (minus closing bracket). |
| public void | writeEndObject(JsonGenerator
Generator used for output g, int Number of direct members of the Object that
have been output nrOfEntries)Implements com. Method called after an Object value has been completely output (minus closing curly bracket). |
| public void | writeObjectEntrySeparator(JsonGenerator
Generator used for output g)Implements com. 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 g)Implements com. Method called after an object field has been output, but before the value is output. |
| public void | writeRootValueSeparator(JsonGenerator
Generator used for output g)Implements com. 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 g)Implements com. 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 g)Implements com. Method called when an Object value is to be output, before any fields are output. |
| _arrayEmptySeparator | back to summary |
|---|---|
| protected String _arrayEmptySeparator String to use in empty Array to separate start and end markers.
Default is single space, resulting in output of
| |
| _arrayIndenter | back to summary |
|---|---|
| protected DefaultPrettyPrinter. By default, let's use only spaces to separate array values. | |
| _arrayValueSeparator | back to summary |
|---|---|
protected String _arrayValueSeparator
| |
| _nesting | back to summary |
|---|---|
| protected transient int _nesting Number of open levels of nesting. Used to determine amount of indentation to use. | |
| _objectEmptySeparator | back to summary |
|---|---|
| protected String _objectEmptySeparator String to use in empty Object to separate start and end markers.
Default is single space, resulting in output of
| |
| _objectEntrySeparator | back to summary |
|---|---|
protected String _objectEntrySeparator
| |
| _objectFieldValueSeparatorWithSpaces | back to summary |
|---|---|
protected String _objectFieldValueSeparatorWithSpaces
| |
| _objectIndenter | back to summary |
|---|---|
| protected DefaultPrettyPrinter. 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) | |
| _rootSeparator | back to summary |
|---|---|
| protected SerializableString _rootSeparator String printed between root-level values, if any. | |
| _separators | back to summary |
|---|---|
protected Separators _separators
| |
| _spacesInObjectEntries | back to summary |
|---|---|
| protected boolean _spacesInObjectEntries
Deprecated in 2.16. Use Separators API instead. By default we will add spaces around colons used to separate object fields and values. If disabled, will not use spaces around colon. | |
| DEFAULT_ROOT_VALUE_SEPARATOR | back to summary |
|---|---|
| public static final SerializedString DEFAULT_ROOT_VALUE_SEPARATOR Hides com. Deprecated in 2.16. Use the Separators API instead. Constant that specifies default "root-level" separator to use between root values: a single space character.
| |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| DefaultPrettyPrinter | back to summary |
|---|---|
| public DefaultPrettyPrinter() | |
| DefaultPrettyPrinter | back to summary |
|---|---|
| public DefaultPrettyPrinter(String rootSeparator)
Deprecated in 2.16. Use the Separators API instead. Constructor that specifies separator String to use between root values; if null, no separator is printed. Note simply constructs a
| |
| DefaultPrettyPrinter | back to summary |
|---|---|
| public DefaultPrettyPrinter(SerializableString rootSeparator)
Deprecated in 2.16. Use the Separators API instead. Constructor that specifies separator String to use between root values; if null, no separator is printed.
| |
| DefaultPrettyPrinter | back to summary |
|---|---|
| public DefaultPrettyPrinter(DefaultPrettyPrinter base, SerializableString rootSeparator)
Deprecated in 2.16. Use the Separators API instead.
| |
| DefaultPrettyPrinter | back to summary |
|---|---|
public DefaultPrettyPrinter(Separators separators)
| |
| DefaultPrettyPrinter | back to summary |
|---|---|
| public DefaultPrettyPrinter(DefaultPrettyPrinter base) Copy constructor
| |
| _withSpaces | back to summary |
|---|---|
| protected DefaultPrettyPrinter _withSpaces(boolean state) | |
| beforeArrayValues | back to summary |
|---|---|
| public void beforeArrayValues(JsonGenerator g) throws IOException Implements com. Doc from com. 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.
| |
| beforeObjectEntries | back to summary |
|---|---|
| public void beforeObjectEntries(JsonGenerator g) throws IOException Implements com. Doc from com. 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.
| |
| createInstance | back to summary |
|---|---|
| public DefaultPrettyPrinter createInstance() Implements com. Doc from com. 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.
| |
| indentArraysWith | back to summary |
|---|---|
| public void indentArraysWith(DefaultPrettyPrinter. | |
| indentObjectsWith | back to summary |
|---|---|
| public void indentObjectsWith(DefaultPrettyPrinter. | |
| withArrayIndenter | back to summary |
|---|---|
public DefaultPrettyPrinter withArrayIndenter(DefaultPrettyPrinter.
| |
| withObjectIndenter | back to summary |
|---|---|
public DefaultPrettyPrinter withObjectIndenter(DefaultPrettyPrinter.
| |
| withoutSpacesInObjectEntries | back to summary |
|---|---|
| public DefaultPrettyPrinter withoutSpacesInObjectEntries()
Deprecated in 2.16. Use the Separators API instead. "Mutant factory" method that will return a pretty printer instance that does not use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.
| |
| withRootSeparator | back to summary |
|---|---|
| public DefaultPrettyPrinter withRootSeparator(SerializableString rootSeparator)
Deprecated in 2.16. Use the Separators API instead.
| |
| withRootSeparator | back to summary |
|---|---|
| public DefaultPrettyPrinter withRootSeparator(String rootSeparator)
Deprecated in 2.16. Use the Separators API instead.
| |
| withSeparators | back to summary |
|---|---|
| public DefaultPrettyPrinter withSeparators(Separators separators) Method for configuring separators for this pretty-printer to use
| |
| withSpacesInObjectEntries | back to summary |
|---|---|
| public DefaultPrettyPrinter withSpacesInObjectEntries()
Deprecated in 2.16. Use the Separators API instead. "Mutant factory" method that will return a pretty printer instance that does use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.
| |
| writeArrayValueSeparator | back to summary |
|---|---|
| public void writeArrayValueSeparator(JsonGenerator g) throws IOException Implements com. 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.
| |
| writeEndArray | back to summary |
|---|---|
| public void writeEndArray(JsonGenerator g, int nrOfValues) throws IOException Implements com. Doc from com. 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.
| |
| writeEndObject | back to summary |
|---|---|
| public void writeEndObject(JsonGenerator g, int nrOfEntries) throws IOException Implements com. Doc from com. 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.
| |
| writeObjectEntrySeparator | back to summary |
|---|---|
| public void writeObjectEntrySeparator(JsonGenerator g) throws IOException Implements com. 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.
| |
| writeObjectFieldValueSeparator | back to summary |
|---|---|
| public void writeObjectFieldValueSeparator(JsonGenerator g) throws IOException Implements com. 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.
| |
| writeRootValueSeparator | back to summary |
|---|---|
| public void writeRootValueSeparator(JsonGenerator g) throws IOException Implements com. Doc from com. 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).
| |
| writeStartArray | back to summary |
|---|---|
| public void writeStartArray(JsonGenerator g) throws IOException Implements com. Doc from com. 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.
| |
| writeStartObject | back to summary |
|---|---|
| public void writeStartObject(JsonGenerator g) throws IOException Implements com. Doc from com. 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.
| |
| Modifier and Type | Field and Description |
|---|---|
| public static final DefaultPrettyPrinter. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | |
| public void |
| instance | back to summary |
|---|---|
| public static final DefaultPrettyPrinter. Hides com. | |
| FixedSpaceIndenter | back to summary |
|---|---|
| public FixedSpaceIndenter() | |
| isInline | back to summary |
|---|---|
| public boolean isInline() Overrides com. Implements com.
| |
| writeIndentation | back to summary |
|---|---|
| public void writeIndentation(JsonGenerator g, int level) throws IOException Overrides com. Implements com.
| |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | |
| public void |
| isInline | back to summary |
|---|---|
public boolean isInline()
| |
| writeIndentation | back to summary |
|---|---|
| public void writeIndentation(JsonGenerator g, int level) throws IOException | |
| Modifier and Type | Field and Description |
|---|---|
| public static final DefaultPrettyPrinter. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | |
| public void | writeIndentation(JsonGenerator g, int level)
Implements com.
|
| instance | back to summary |
|---|---|
| public static final DefaultPrettyPrinter. | |
| NopIndenter | back to summary |
|---|---|
| public NopIndenter() | |
| isInline | back to summary |
|---|---|
| public boolean isInline() Implements com.
| |
| writeIndentation | back to summary |
|---|---|
| public void writeIndentation(JsonGenerator g, int level) throws IOException Implements com.
| |