public class MinimalPrettyPrinter extends Object implements PrettyPrinter, Serializable
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.
Modifier and Type | Field and Description |
---|---|
protected String |
_rootValueSeparator |
static String |
DEFAULT_ROOT_VALUE_SEPARATOR
Default String used for separating root values is single space.
|
Constructor and Description |
---|
MinimalPrettyPrinter() |
MinimalPrettyPrinter(String rootValueSeparator) |
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 |
setRootValueSeparator(String sep) |
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.
|
public static final String DEFAULT_ROOT_VALUE_SEPARATOR
protected String _rootValueSeparator
public MinimalPrettyPrinter()
public MinimalPrettyPrinter(String rootValueSeparator)
public void setRootValueSeparator(String sep)
public void writeRootValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
PrettyPrinter
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).
writeRootValueSeparator
in interface PrettyPrinter
IOException
JsonGenerationException
public void writeStartObject(JsonGenerator jg) throws IOException, JsonGenerationException
PrettyPrinter
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.
writeStartObject
in interface PrettyPrinter
IOException
JsonGenerationException
public void beforeObjectEntries(JsonGenerator jg) throws IOException, JsonGenerationException
PrettyPrinter
Default handling does not output anything, but pretty-printer is free to add any white space decoration.
beforeObjectEntries
in interface PrettyPrinter
IOException
JsonGenerationException
public void writeObjectFieldValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
Default handling will just output a single colon to separate the two, without additional spaces.
writeObjectFieldValueSeparator
in interface PrettyPrinter
IOException
JsonGenerationException
public void writeObjectEntrySeparator(JsonGenerator jg) throws IOException, JsonGenerationException
Default handling (without pretty-printing) will output a single comma to separate the two.
writeObjectEntrySeparator
in interface PrettyPrinter
IOException
JsonGenerationException
public void writeEndObject(JsonGenerator jg, int nrOfEntries) throws IOException, JsonGenerationException
PrettyPrinter
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.
writeEndObject
in interface PrettyPrinter
nrOfEntries
- Number of direct members of the array that
have been outputIOException
JsonGenerationException
public void writeStartArray(JsonGenerator jg) throws IOException, JsonGenerationException
PrettyPrinter
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.
writeStartArray
in interface PrettyPrinter
IOException
JsonGenerationException
public void beforeArrayValues(JsonGenerator jg) throws IOException, JsonGenerationException
PrettyPrinter
Default handling does not output anything, but pretty-printer is free to add any white space decoration.
beforeArrayValues
in interface PrettyPrinter
IOException
JsonGenerationException
public void writeArrayValueSeparator(JsonGenerator jg) throws IOException, JsonGenerationException
Default handling (without pretty-printing) will output a single comma to separate values.
writeArrayValueSeparator
in interface PrettyPrinter
IOException
JsonGenerationException
public void writeEndArray(JsonGenerator jg, int nrOfValues) throws IOException, JsonGenerationException
PrettyPrinter
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.
writeEndArray
in interface PrettyPrinter
nrOfValues
- Number of direct members of the array that
have been outputIOException
JsonGenerationException
Copyright © 2017 JBoss by Red Hat. All rights reserved.