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

Interface PrettyPrinter

All Known Implementing Classes:
DefaultPrettyPrinter, MinimalPrettyPrinter
public interface PrettyPrinter
Interface for objects that implement pretty printer functionality, such as indentation. Pretty printers are used to add white space in output JSON content, to make results more human readable. Usually this means things like adding linefeeds and indentation.

Note: stateful implementations MUST implement Instantiatable interface, to allow for constructing per-generation instances and avoid state corruption. Stateless implementations need not do this; but those are less common.

  • Field Details

    • DEFAULT_SEPARATORS

      static final Separators DEFAULT_SEPARATORS

    • DEFAULT_ROOT_VALUE_SEPARATOR

      static final SerializedString DEFAULT_ROOT_VALUE_SEPARATOR
      Default String used for separating root values is single space.

  • Method Details

    • writeRootValueSeparator

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

    • writeStartObject

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

    • writeEndObject

      void writeEndObject(JsonGenerator g, int nrOfEntries) throws JacksonException
      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 - 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

    • writeObjectEntrySeparator

      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. Pretty-printer is to output a comma as well, but can surround that with other (white-space) decoration.

      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

      void writeObjectNameValueSeparator(JsonGenerator g) throws JacksonException
      Method called after an Object property name 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.

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

    • writeStartArray

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

    • writeEndArray

      void writeEndArray(JsonGenerator g, int nrOfValues) throws JacksonException
      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 - 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

    • writeArrayValueSeparator

      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 the two. Pretty-printer is to output a comma as well, but can surround that with other (white-space) decoration.

      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

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

    • beforeObjectEntries

      void beforeObjectEntries(JsonGenerator g) throws JacksonException
      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.

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