DefaultPrettyPrinter
Date: 2016-12-03

com.fasterxml.jackson.core.util

## Class DefaultPrettyPrinter

- java.lang.Object
- - com.fasterxml.jackson.core.util.DefaultPrettyPrinter

- All Implemented Interfaces:
    PrettyPrinter, Instantiatable<DefaultPrettyPrinter>, java.io.Serializable

      public class DefaultPrettyPrinter
      extends java.lang.Object
      implements PrettyPrinter, Instantiatable<DefaultPrettyPrinter>, java.io.Serializable

  Default `PrettyPrinter` implementation that uses 2-space indentation with platform-default linefeeds. Usually this class is not instantiated directly, but instead method `JsonGenerator.useDefaultPrettyPrinter()` is used, which will use an instance of this class for operation.
  See Also:
    Serialized Form

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `DefaultPrettyPrinter.FixedSpaceIndenter` This is a very simple indenter that only adds a single space for indentation.
    `static interface` | `DefaultPrettyPrinter.Indenter` Interface that defines objects that can produce indentation used to separate object entries and array values.
    `static class` | `DefaultPrettyPrinter.NopIndenter` Dummy implementation that adds no indentation whatsoever

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected DefaultPrettyPrinter.Indenter` | `_arrayIndenter` By default, let's use only spaces to separate array values.
    `protected int` | `_nesting` Number of open levels of nesting.
    `protected DefaultPrettyPrinter.Indenter` | `_objectIndenter` By default, let's use linefeed-adding indenter for separate object entries.
    `protected SerializableString` | `_rootSeparator` String printed between root-level values, if any.
    `protected boolean` | `_spacesInObjectEntries` By default we will add spaces around colons used to separate object fields and values.
    `static SerializedString` | `DEFAULT_ROOT_VALUE_SEPARATOR` Constant that specifies default "root-level" separator to use between root values: a single space character.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `DefaultPrettyPrinter()`
    `DefaultPrettyPrinter(DefaultPrettyPrinter base)`
    `DefaultPrettyPrinter(DefaultPrettyPrinter base, SerializableString rootSeparator)`
    `DefaultPrettyPrinter(SerializableString rootSeparator)` Constructor that specifies separator String to use between root values; if null, no separator is printed.
    `DefaultPrettyPrinter(java.lang.String rootSeparator)` Constructor that specifies separator String to use between root values; if null, no separator is printed.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected DefaultPrettyPrinter` | `_withSpaces(boolean state)`
    `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.
    `DefaultPrettyPrinter` | `createInstance()` Method called to ensure that we have a non-blueprint object to use; it is either this object (if stateless), or a newly created object with separate state.
    `void` | `indentArraysWith(DefaultPrettyPrinter.Indenter i)`
    `void` | `indentObjectsWith(DefaultPrettyPrinter.Indenter i)`
    `void` | `spacesInObjectEntries(boolean b)` Deprecated. Since 2.3 use `withSpacesInObjectEntries()` and `withoutSpacesInObjectEntries()`
    `DefaultPrettyPrinter` | `withArrayIndenter(DefaultPrettyPrinter.Indenter i)`
    `DefaultPrettyPrinter` | `withObjectIndenter(DefaultPrettyPrinter.Indenter i)`
    `DefaultPrettyPrinter` | `withoutSpacesInObjectEntries()` "Mutant factory" method that will return a pretty printer instance that does not use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.
    `DefaultPrettyPrinter` | `withRootSeparator(SerializableString rootSeparator)`
    `DefaultPrettyPrinter` | `withRootSeparator(java.lang.String rootSeparator)`
    `DefaultPrettyPrinter` | `withSpacesInObjectEntries()` "Mutant factory" method that will return a pretty printer instance that does use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.
    `void` | `writeArrayValueSeparator(JsonGenerator gen)` Method called after an array value has been completely output, and before another value is to be output.
    `void` | `writeEndArray(JsonGenerator gen, 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 SerializedString DEFAULT_ROOT_VALUE_SEPARATOR

      Constant that specifies default "root-level" separator to use between root values: a single space character.
      Since:
        2.1

    - #### _arrayIndenter

          protected DefaultPrettyPrinter.Indenter _arrayIndenter

      By default, let's use only spaces to separate array values.

    - #### _objectIndenter

          protected DefaultPrettyPrinter.Indenter _objectIndenter

      By default, let's use linefeed-adding indenter for separate object entries. We'll further configure indenter to use system-specific linefeeds, and 2 spaces per level (as opposed to, say, single tabs)

    - #### _rootSeparator

          protected final SerializableString _rootSeparator

      String printed between root-level values, if any.

    - #### _spacesInObjectEntries

          protected boolean _spacesInObjectEntries

      By default we will add spaces around colons used to separate object fields and values. If disabled, will not use spaces around colon.

    - #### _nesting

          protected transient int _nesting

      Number of open levels of nesting. Used to determine amount of indentation to use.

  - ### Constructor Detail

    - #### DefaultPrettyPrinter

          public DefaultPrettyPrinter()

    - #### DefaultPrettyPrinter

          public DefaultPrettyPrinter(java.lang.String rootSeparator)

      Constructor that specifies separator String to use between root values; if null, no separator is printed.

      Note: simply constructs a `SerializedString` out of parameter, calls `DefaultPrettyPrinter(SerializableString)`

      Parameters:
        `rootSeparator` -
      Since:
        2.1

    - #### DefaultPrettyPrinter

          public DefaultPrettyPrinter(SerializableString rootSeparator)

      Constructor that specifies separator String to use between root values; if null, no separator is printed.
      Parameters:
        `rootSeparator` -
      Since:
        2.1

    - #### DefaultPrettyPrinter

          public DefaultPrettyPrinter(DefaultPrettyPrinter base)

    - #### DefaultPrettyPrinter

          public DefaultPrettyPrinter(DefaultPrettyPrinter base,
                              SerializableString rootSeparator)

  - ### Method Detail

    - #### withRootSeparator

          public DefaultPrettyPrinter withRootSeparator(SerializableString rootSeparator)

    - #### withRootSeparator

          public DefaultPrettyPrinter withRootSeparator(java.lang.String rootSeparator)

      Since:
        2.6.0

    - #### indentArraysWith

          public void indentArraysWith(DefaultPrettyPrinter.Indenter i)

    - #### indentObjectsWith

          public void indentObjectsWith(DefaultPrettyPrinter.Indenter i)

    - #### spacesInObjectEntries

          @Deprecated
          public void spacesInObjectEntries(boolean b)

      Deprecated. Since 2.3 use `withSpacesInObjectEntries()` and `withoutSpacesInObjectEntries()`

    - #### withArrayIndenter

          public DefaultPrettyPrinter withArrayIndenter(DefaultPrettyPrinter.Indenter i)

      Since:
        2.3

    - #### withObjectIndenter

          public DefaultPrettyPrinter withObjectIndenter(DefaultPrettyPrinter.Indenter i)

      Since:
        2.3

    - #### withSpacesInObjectEntries

          public DefaultPrettyPrinter withSpacesInObjectEntries()

      "Mutant factory" method that will return a pretty printer instance that does use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.
      Since:
        2.3

    - #### withoutSpacesInObjectEntries

          public DefaultPrettyPrinter withoutSpacesInObjectEntries()

      "Mutant factory" method that will return a pretty printer instance that does not use spaces inside object entries; if 'this' instance already does this, it is returned; if not, a new instance will be constructed and returned.
      Since:
        2.3

    - #### _withSpaces

          protected DefaultPrettyPrinter _withSpaces(boolean state)

    - #### createInstance

          public DefaultPrettyPrinter createInstance()

      Description copied from interface: `Instantiatable`
      Method called to ensure that we have a non-blueprint object to use; it is either this object (if stateless), or a newly created object with separate state.
      Specified by:
        `createInstance` in interface `Instantiatable<DefaultPrettyPrinter>`

    - #### writeRootValueSeparator

          public void writeRootValueSeparator(JsonGenerator jg)
                                       throws java.io.IOException

      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:
        `java.io.IOException`

    - #### writeStartObject

          public void writeStartObject(JsonGenerator jg)
                                throws java.io.IOException

      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:
        `java.io.IOException`

    - #### beforeObjectEntries

          public void beforeObjectEntries(JsonGenerator jg)
                                   throws java.io.IOException

      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:
        `java.io.IOException`

    - #### writeObjectFieldValueSeparator

          public void writeObjectFieldValueSeparator(JsonGenerator jg)
                                              throws java.io.IOException

      Method called after an object field 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.

      Specified by:
        `writeObjectFieldValueSeparator` in interface `PrettyPrinter`
      Throws:
        `java.io.IOException`

    - #### writeObjectEntrySeparator

          public void writeObjectEntrySeparator(JsonGenerator jg)
                                         throws java.io.IOException

      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.

      Specified by:
        `writeObjectEntrySeparator` in interface `PrettyPrinter`
      Throws:
        `java.io.IOException`

    - #### writeEndObject

          public void writeEndObject(JsonGenerator jg,
                            int nrOfEntries)
                              throws java.io.IOException

      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:
        `java.io.IOException`

    - #### writeStartArray

          public void writeStartArray(JsonGenerator jg)
                               throws java.io.IOException

      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:
        `java.io.IOException`

    - #### beforeArrayValues

          public void beforeArrayValues(JsonGenerator jg)
                                 throws java.io.IOException

      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:
        `java.io.IOException`

    - #### writeArrayValueSeparator

          public void writeArrayValueSeparator(JsonGenerator gen)
                                        throws java.io.IOException

      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.

      Specified by:
        `writeArrayValueSeparator` in interface `PrettyPrinter`
      Throws:
        `java.io.IOException`

    - #### writeEndArray

          public void writeEndArray(JsonGenerator gen,
                           int nrOfValues)
                             throws java.io.IOException

      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:
        `java.io.IOException`