Top Description Fields Constructors Methods
com.fasterxml.jackson.core.util

public Class MinimalPrettyPrinter

extends Object
implements PrettyPrinter, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, com.fasterxml.jackson.core.PrettyPrinter
Imports
java.io.IOException, com.fasterxml.jackson.core.JsonGenerator, .PrettyPrinter, com.fasterxml.jackson.core.util.Separators.Spacing
PrettyPrinter implementation that adds no indentation, just implements everything necessary for value output to work as expected, and provide simpler extension points to allow for creating simple custom implementations that add specific decoration or overrides. Since behavior then is very similar to using no pretty printer at all, usually sub-classes are used.

Beyond purely minimal implementation, there is limited amount of configurability which may be useful for actual use: for example, it is possible to redefine separator used between root-level values (default is single space; can be changed to line-feed).

Note

does NOT implement Instantiatable since this is a stateless implementation; that is, a single instance can be shared between threads.

Field Summary

Modifier and TypeField and Description
protected String
_rootValueSeparator

protected Separators
_separators

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
MinimalPrettyPrinter()

public
MinimalPrettyPrinter(String rootValueSeparator)

Method Summary

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

Implements com.fasterxml.jackson.core.PrettyPrinter.beforeArrayValues.

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.fasterxml.jackson.core.PrettyPrinter.beforeObjectEntries.

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
setRootValueSeparator(String sep)

public MinimalPrettyPrinter

Returns:

This pretty-printer instance to allow call chaining
setSeparators(Separators
Separator definitions
separators)

public void
writeArrayValueSeparator(JsonGenerator
Generator used for output
g)

Implements com.fasterxml.jackson.core.PrettyPrinter.writeArrayValueSeparator.

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.fasterxml.jackson.core.PrettyPrinter.writeEndArray.

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.fasterxml.jackson.core.PrettyPrinter.writeEndObject.

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.fasterxml.jackson.core.PrettyPrinter.writeObjectEntrySeparator.

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.fasterxml.jackson.core.PrettyPrinter.writeObjectFieldValueSeparator.

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.fasterxml.jackson.core.PrettyPrinter.writeRootValueSeparator.

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.fasterxml.jackson.core.PrettyPrinter.writeStartArray.

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.fasterxml.jackson.core.PrettyPrinter.writeStartObject.

Method called when an Object value is to be output, before any fields are output.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_rootValueSeparatorback to summary
protected String _rootValueSeparator
_separatorsback to summary
protected Separators _separators
Since
2.9
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

MinimalPrettyPrinterback to summary
public MinimalPrettyPrinter()
MinimalPrettyPrinterback to summary
public MinimalPrettyPrinter(String rootValueSeparator)

Method Detail

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

Implements com.fasterxml.jackson.core.PrettyPrinter.beforeArrayValues.

Doc from com.fasterxml.jackson.core.PrettyPrinter.beforeArrayValues.

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
g:JsonGenerator

Generator used for output

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

Implements com.fasterxml.jackson.core.PrettyPrinter.beforeObjectEntries.

Doc from com.fasterxml.jackson.core.PrettyPrinter.beforeObjectEntries.

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
g:JsonGenerator

Generator used for output

Annotations
@Override
Exceptions
IOException:
if there is either an underlying I/O problem or encoding issue at format layer
setRootValueSeparatorback to summary
public void setRootValueSeparator(String sep)
setSeparatorsback to summary
public MinimalPrettyPrinter setSeparators(Separators separators)
Parameters
separators:Separators

Separator definitions

Returns:MinimalPrettyPrinter

This pretty-printer instance to allow call chaining

Since
2.9
writeArrayValueSeparatorback to summary
public void writeArrayValueSeparator(JsonGenerator g) throws IOException

Implements com.fasterxml.jackson.core.PrettyPrinter.writeArrayValueSeparator.

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 values.

Parameters
g:JsonGenerator

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeArrayValueSeparator.

Generator used for output

Annotations
@Override
Exceptions
IOException:

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeArrayValueSeparator.

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

writeEndArrayback to summary
public void writeEndArray(JsonGenerator g, int nrOfValues) throws IOException

Implements com.fasterxml.jackson.core.PrettyPrinter.writeEndArray.

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeEndArray.

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
g:JsonGenerator

Generator used for output

nrOfValues:int

Number of direct members of the array that have been output

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

Implements com.fasterxml.jackson.core.PrettyPrinter.writeEndObject.

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeEndObject.

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
g:JsonGenerator

Generator used for output

nrOfEntries:int

Number of direct members of the Object that have been output

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

Implements com.fasterxml.jackson.core.PrettyPrinter.writeObjectEntrySeparator.

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.

Parameters
g:JsonGenerator

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeObjectEntrySeparator.

Generator used for output

Annotations
@Override
Exceptions
IOException:

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeObjectEntrySeparator.

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

writeObjectFieldValueSeparatorback to summary
public void writeObjectFieldValueSeparator(JsonGenerator g) throws IOException

Implements com.fasterxml.jackson.core.PrettyPrinter.writeObjectFieldValueSeparator.

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

Default handling will just output a single colon to separate the two, without additional spaces.

Parameters
g:JsonGenerator

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeObjectFieldValueSeparator.

Generator used for output

Annotations
@Override
Exceptions
IOException:

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeObjectFieldValueSeparator.

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

writeRootValueSeparatorback to summary
public void writeRootValueSeparator(JsonGenerator g) throws IOException

Implements com.fasterxml.jackson.core.PrettyPrinter.writeRootValueSeparator.

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeRootValueSeparator.

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
g:JsonGenerator

Generator used for output

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

Implements com.fasterxml.jackson.core.PrettyPrinter.writeStartArray.

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeStartArray.

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
g:JsonGenerator

Generator used for output

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

Implements com.fasterxml.jackson.core.PrettyPrinter.writeStartObject.

Doc from com.fasterxml.jackson.core.PrettyPrinter.writeStartObject.

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
g:JsonGenerator

Generator used for output

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