Module tools.jackson.core
Package tools.jackson.core.util

Class MinimalPrettyPrinter

java.lang.Object
tools.jackson.core.util.MinimalPrettyPrinter
All Implemented Interfaces:
Serializable, PrettyPrinter
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.

See Also:

  • Field Details

    • _rootValueSeparator

      protected String _rootValueSeparator

    • _separators

      protected Separators _separators

  • Constructor Details

    • MinimalPrettyPrinter

      public MinimalPrettyPrinter()

    • MinimalPrettyPrinter

      public MinimalPrettyPrinter(String rootValueSeparator)

  • Method Details

    • setRootValueSeparator

      public void setRootValueSeparator(String sep)

    • setSeparators

      public MinimalPrettyPrinter setSeparators(Separators separators)
      Parameters:
      separators - Separator definitions
      Returns:
      This pretty-printer instance to allow call chaining

    • writeRootValueSeparator

      public void writeRootValueSeparator(JsonGenerator g) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartObject

      public void writeStartObject(JsonGenerator g) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • beforeObjectEntries

      public void beforeObjectEntries(JsonGenerator g) throws JacksonException
      Description copied from interface: PrettyPrinter
      Method called after object start marker has been output, and right before the Name of the first property is to be output. It is not called for objects without properties.

      Default handling does not output anything, but pretty-printer is free to add any white space decoration.

      Specified by:
      beforeObjectEntries in interface PrettyPrinter
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeObjectNameValueSeparator

      public void writeObjectNameValueSeparator(JsonGenerator g) throws JacksonException
      Method called after the Object property name 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:
      writeObjectNameValueSeparator in interface PrettyPrinter
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeObjectEntrySeparator

      public void writeObjectEntrySeparator(JsonGenerator g) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeEndObject

      public void writeEndObject(JsonGenerator g, int nrOfEntries) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      nrOfEntries - Number of direct members of the Object that have been output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeStartArray

      public void writeStartArray(JsonGenerator g) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • beforeArrayValues

      public void beforeArrayValues(JsonGenerator g) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeArrayValueSeparator

      public void writeArrayValueSeparator(JsonGenerator g) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException

    • writeEndArray

      public void writeEndArray(JsonGenerator g, int nrOfValues) throws JacksonException
      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
      Parameters:
      g - Generator used for output
      nrOfValues - Number of direct members of the array that have been output
      Throws:
      JacksonIOException - if there is an underlying I/O problem
      StreamWriteException - for problems in encoding token stream
      JacksonException