org.codehaus.jackson.util

Class MinimalPrettyPrinter

java.lang.Object

org.codehaus.jackson.util.MinimalPrettyPrinter

All Implemented Interfaces:

PrettyPrinter

public class MinimalPrettyPrinter
extends Object
implements PrettyPrinter

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

Since:

1.6

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
MinimalPrettyPrinter()
MinimalPrettyPrinter(String rootValueSeparator)

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROOT_VALUE_SEPARATOR

public static final String DEFAULT_ROOT_VALUE_SEPARATOR

Default String used for separating root values is single space.

See Also:

Constant Field Values

_rootValueSeparator

protected String _rootValueSeparator

Constructor Detail

MinimalPrettyPrinter

public MinimalPrettyPrinter()

MinimalPrettyPrinter

public MinimalPrettyPrinter(String rootValueSeparator)

Since:

1.9

Method Detail

setRootValueSeparator

public void setRootValueSeparator(String sep)

writeRootValueSeparator

public void writeRootValueSeparator(JsonGenerator jg)
                             throws IOException,
                                    JsonGenerationException

Description copied from interface: PrettyPrinter

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

Specified by:

writeRootValueSeparator in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

writeStartObject

public void writeStartObject(JsonGenerator jg)
                      throws IOException,
                             JsonGenerationException

Description copied from interface: PrettyPrinter

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.

Specified by:

writeStartObject in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

beforeObjectEntries

public void beforeObjectEntries(JsonGenerator jg)
                         throws IOException,
                                JsonGenerationException

Description copied from interface: PrettyPrinter

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.

Specified by:

beforeObjectEntries in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

writeObjectFieldValueSeparator

public void writeObjectFieldValueSeparator(JsonGenerator jg)
                                    throws IOException,
                                           JsonGenerationException

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.

Specified by:

writeObjectFieldValueSeparator in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

writeObjectEntrySeparator

public void writeObjectEntrySeparator(JsonGenerator jg)
                               throws IOException,
                                      JsonGenerationException

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.

Specified by:

writeObjectEntrySeparator in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

writeEndObject

public void writeEndObject(JsonGenerator jg,
                  int nrOfEntries)
                    throws IOException,
                           JsonGenerationException

Description copied from interface: PrettyPrinter

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.

Specified by:

writeEndObject in interface PrettyPrinter

nrOfEntries - Number of direct members of the array that have been output

Throws:

IOException

JsonGenerationException

writeStartArray

public void writeStartArray(JsonGenerator jg)
                     throws IOException,
                            JsonGenerationException

Description copied from interface: PrettyPrinter

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.

Specified by:

writeStartArray in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

beforeArrayValues

public void beforeArrayValues(JsonGenerator jg)
                       throws IOException,
                              JsonGenerationException

Description copied from interface: PrettyPrinter

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.

Specified by:

beforeArrayValues in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

writeArrayValueSeparator

public void writeArrayValueSeparator(JsonGenerator jg)
                              throws IOException,
                                     JsonGenerationException

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.

Specified by:

writeArrayValueSeparator in interface PrettyPrinter

Throws:

IOException

JsonGenerationException

writeEndArray

public void writeEndArray(JsonGenerator jg,
                 int nrOfValues)
                   throws IOException,
                          JsonGenerationException

Description copied from interface: PrettyPrinter

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.

Specified by:

writeEndArray in interface PrettyPrinter

nrOfValues - Number of direct members of the array that have been output

Throws:

IOException

JsonGenerationException