Minor tweaks to #374, update release notes

Author: cowtowncoder

release-notes/CREDITS

@@ -135,3 +135,7 @@ Michael Sims (MichaelSims@github)
   * Reported, contributed fix for #372: JsonParserSequence#skipChildren() throws exception
    when current delegate is TokenBuffer.Parser with "incomplete" JSON
    (2.9.0)
+
+Rafal Foltynski (rfoltyns@github)
+  * Contributed #374: Minimal and DefaultPrettyPrinter with configurable separators
+   (2.9.0)

release-notes/VERSION

@@ -34,6 +34,8 @@ JSON library.
 #372: JsonParserSequence#skipChildren() throws exception when current delegate is
   TokenBuffer.Parser with "incomplete" JSON
  (contributed by Michael S)
+#374: Minimal and DefaultPrettyPrinter with configurable separators 
+ (contributed by Rafal F)
 
 2.8.8 (05-Apr-2017)
 

src/main/java/com/fasterxml/jackson/core/PrettyPrinter.java

@@ -7,6 +7,9 @@
 
 import java.io.IOException;
 
+import com.fasterxml.jackson.core.io.SerializedString;
+import com.fasterxml.jackson.core.util.Separators;
+
 /**
  * Interface for objects that implement pretty printer functionality, such
  * as indentation.
@@ -17,11 +20,23 @@
  * Note: since Jackson 2.1, stateful implementations MUST implement
  * {@link com.fasterxml.jackson.core.util.Instantiatable} interface,
  * to allow for constructing  per-generation instances and avoid
- * state corruption (see [JACKSON-851] for details).
+ * state corruption.
  * Stateless implementations need not do this; but those are less common.
  */
 public interface PrettyPrinter
 {
+    /**
+     * @since 2.9
+     */
+    public final static Separators DEFAULT_SEPARATORS = Separators.createDefaultInstance();
+
+    /**
+     * Default String used for separating root values is single space.
+     * 
+     * @since 2.9
+     */
+    public final static SerializedString DEFAULT_ROOT_VALUE_SEPARATOR = new SerializedString(" ");
+
     /*
     /**********************************************************
     /* First methods that act both as events, and expect
@@ -42,8 +57,7 @@ public interface PrettyPrinter
      * to output some other suitable and nice-looking separator
      * (tab(s), space(s), linefeed(s) or any combination thereof).
      */
-    void writeRootValueSeparator(JsonGenerator jg)
-        throws IOException, JsonGenerationException;
+    void writeRootValueSeparator(JsonGenerator gen) throws IOException;
 
     // // Object handling
 
@@ -57,8 +71,7 @@ void writeRootValueSeparator(JsonGenerator jg)
      * to output a curly bracket as well, but can surround that
      * with other (white-space) decoration.
      */
-    void writeStartObject(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void writeStartObject(JsonGenerator gen) throws IOException;
 
     /**
      * Method called after an Object value has been completely output
@@ -73,8 +86,7 @@ void writeStartObject(JsonGenerator gen)
      * @param nrOfEntries Number of direct members of the array that
      *   have been output
      */
-    void writeEndObject(JsonGenerator gen, int nrOfEntries)
-        throws IOException, JsonGenerationException;
+    void writeEndObject(JsonGenerator gen, int nrOfEntries) throws IOException;
 
     /**
      * Method called after an object entry (field:value) has been completely
@@ -85,8 +97,7 @@ void writeEndObject(JsonGenerator gen, int nrOfEntries)
      * to output a comma as well, but can surround that with other
      * (white-space) decoration.
      */
-    void writeObjectEntrySeparator(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void writeObjectEntrySeparator(JsonGenerator gen) throws IOException;
 
     /**
      * Method called after an object field has been output, but
@@ -97,8 +108,7 @@ void writeObjectEntrySeparator(JsonGenerator gen)
      * to output a colon as well, but can surround that with other
      * (white-space) decoration.
      */
-    void writeObjectFieldValueSeparator(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void writeObjectFieldValueSeparator(JsonGenerator gen) throws IOException;
 
     // // // Array handling
 
@@ -112,8 +122,7 @@ void writeObjectFieldValueSeparator(JsonGenerator gen)
      * to output a bracket as well, but can surround that
      * with other (white-space) decoration.
      */
-    void writeStartArray(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void writeStartArray(JsonGenerator gen) throws IOException;
 
     /**
      * Method called after an Array value has been completely output
@@ -128,8 +137,7 @@ void writeStartArray(JsonGenerator gen)
      * @param nrOfValues Number of direct members of the array that
      *   have been output
      */
-    void writeEndArray(JsonGenerator gen, int nrOfValues)
-        throws IOException, JsonGenerationException;
+    void writeEndArray(JsonGenerator gen, int nrOfValues) throws IOException;
 
     /**
      * Method called after an array value has been completely
@@ -140,8 +148,7 @@ void writeEndArray(JsonGenerator gen, int nrOfValues)
      * to output a comma as well, but can surround that with other
      * (white-space) decoration.
      */
-    void writeArrayValueSeparator(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void writeArrayValueSeparator(JsonGenerator gen) throws IOException;
 
     /*
     /**********************************************************
@@ -159,8 +166,7 @@ void writeArrayValueSeparator(JsonGenerator gen)
      * Default handling does not output anything, but pretty-printer
      * is free to add any white space decoration.
      */
-    void beforeArrayValues(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void beforeArrayValues(JsonGenerator gen) throws IOException;
 
     /**
      * Method called after object start marker has been output,
@@ -171,7 +177,6 @@ void beforeArrayValues(JsonGenerator gen)
      * Default handling does not output anything, but pretty-printer
      * is free to add any white space decoration.
      */
-    void beforeObjectEntries(JsonGenerator gen)
-        throws IOException, JsonGenerationException;
+    void beforeObjectEntries(JsonGenerator gen) throws IOException;
 }
 

src/main/java/com/fasterxml/jackson/core/Separators.java

@@ -81,9 +81,15 @@ public interface Indenter
      */
     protected transient int _nesting;
 
-    protected Separators _separators = Separators.createDefaultInstance();
+    /**
+     * @since 2.9
+     */
+    protected Separators _separators;
 
-    private String _objectFieldValueSeparatorWithSpaces = " " + _separators.getObjectFieldValueSeparator() + " ";
+    /**
+     * @since 2.9
+     */
+    protected String _objectFieldValueSeparatorWithSpaces;
 
     /*
     /**********************************************************
@@ -120,6 +126,7 @@ public DefaultPrettyPrinter(String rootSeparator) {
      */
     public DefaultPrettyPrinter(SerializableString rootSeparator) {
         _rootSeparator = rootSeparator;
+        withSeparators(DEFAULT_SEPARATORS);
     }
 
     public DefaultPrettyPrinter(DefaultPrettyPrinter base) {
@@ -133,8 +140,9 @@ public DefaultPrettyPrinter(DefaultPrettyPrinter base,
         _objectIndenter = base._objectIndenter;
         _spacesInObjectEntries = base._spacesInObjectEntries;
         _nesting = base._nesting;
+
         _separators = base._separators;
-        _objectFieldValueSeparatorWithSpaces = " " + base._separators.getObjectFieldValueSeparator() + " ";
+        _objectFieldValueSeparatorWithSpaces = base._objectFieldValueSeparatorWithSpaces;
 
         _rootSeparator = rootSeparator;
     }
@@ -163,12 +171,6 @@ public void indentObjectsWith(Indenter i) {
         _objectIndenter = (i == null) ? NopIndenter.instance : i;
     }
 
-    /**
-     * @deprecated Since 2.3 use {@link #withSpacesInObjectEntries} and {@link #withoutSpacesInObjectEntries()}
-     */
-    @Deprecated
-    public void spacesInObjectEntries(boolean b) { _spacesInObjectEntries = b; }
-
     /**
      * @since 2.3
      */
@@ -233,9 +235,12 @@ protected DefaultPrettyPrinter _withSpaces(boolean state)
         return pp;
     }
 
-    public DefaultPrettyPrinter withCustomSeparators(Separators separators) {
-        this._separators = separators;
-        this._objectFieldValueSeparatorWithSpaces = " " + separators.getObjectFieldValueSeparator() + " ";
+    /**
+     * @since 2.9
+     */
+    public DefaultPrettyPrinter withSeparators(Separators separators) {
+        _separators = separators;
+        _objectFieldValueSeparatorWithSpaces = " " + separators.getObjectFieldValueSeparator() + " ";
         return this;
     }
 
@@ -400,7 +405,6 @@ public void writeIndentation(JsonGenerator g, int level) throws IOException { }
      */
     public static class FixedSpaceIndenter extends NopIndenter
     {
-        @SuppressWarnings("hiding")
         public static final FixedSpaceIndenter instance = new FixedSpaceIndenter();
 
         @Override

src/main/java/com/fasterxml/jackson/core/util/DefaultPrettyPrinter.java

@@ -4,7 +4,6 @@
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.PrettyPrinter;
-import com.fasterxml.jackson.core.Separators;
 
 /**
  * {@link PrettyPrinter} implementation that adds no indentation,
@@ -28,14 +27,12 @@ public class MinimalPrettyPrinter
 {
     private static final long serialVersionUID = 1L;
 
+    protected String _rootValueSeparator;
+
     /**
-     * Default String used for separating root values is single space.
+     * @since 2.9
      */
-    public final static String DEFAULT_ROOT_VALUE_SEPARATOR = " ";
-
-    protected String _rootValueSeparator = DEFAULT_ROOT_VALUE_SEPARATOR;
-
-    protected Separators _separators = Separators.createDefaultInstance();
+    protected Separators _separators;
 
     /*
     /**********************************************************
@@ -44,20 +41,26 @@ public class MinimalPrettyPrinter
      */
 
     public MinimalPrettyPrinter() {
-        this(DEFAULT_ROOT_VALUE_SEPARATOR);
+        this(DEFAULT_ROOT_VALUE_SEPARATOR.toString());
     }
 
     public MinimalPrettyPrinter(String rootValueSeparator) {
         _rootValueSeparator = rootValueSeparator;
+        _separators = DEFAULT_SEPARATORS;
     }
-    public MinimalPrettyPrinter withCustomSeparators(Separators separators) {
-        this._separators = separators;
-        return this;
-    }
+
     public void setRootValueSeparator(String sep) {
         _rootValueSeparator = sep;
     }
 
+    /**
+     * @since 2.9
+     */
+    public MinimalPrettyPrinter setSeparators(Separators separators) {
+        _separators = separators;
+        return this;
+    }
+
     /*
     /**********************************************************
     /* PrettyPrinter impl

src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java

@@ -0,0 +1,63 @@
+package com.fasterxml.jackson.core.util;
+
+import java.io.Serializable;
+
+/**
+ * Value class used with some {@link com.fasterxml.jackson.core.PrettyPrinter}
+ * implements
+ *
+ * @see com.fasterxml.jackson.core.util.DefaultPrettyPrinter
+ * @see com.fasterxml.jackson.core.util.MinimalPrettyPrinter
+ * 
+ * @since 2.9
+ */
+public class Separators implements Serializable
+{
+    private static final long serialVersionUID = 1;
+
+    private final char objectFieldValueSeparator;
+    private final char objectEntrySeparator;
+    private final char arrayValueSeparator;
+
+    public static Separators createDefaultInstance() {
+        return new Separators();
+    }
+
+    public Separators() {
+        this(':', ',', ',');
+    }
+
+    public Separators(char objectFieldValueSeparator,
+            char objectEntrySeparator, char arrayValueSeparator) {
+        this.objectFieldValueSeparator = objectFieldValueSeparator;
+        this.objectEntrySeparator = objectEntrySeparator;
+        this.arrayValueSeparator = arrayValueSeparator;
+    }
+    
+    public Separators withObjectFieldValueSeparator(char sep) {
+        return (objectFieldValueSeparator == sep) ? this
+                : new Separators(sep, objectEntrySeparator, arrayValueSeparator);
+    }
+
+    public Separators withObjectEntrySeparator(char sep) {
+        return (objectEntrySeparator == sep) ? this
+                : new Separators(objectFieldValueSeparator, sep, arrayValueSeparator);
+    }
+
+    public Separators withArrayValueSeparator(char sep) {
+        return (arrayValueSeparator == sep) ? this
+                : new Separators(objectFieldValueSeparator, objectEntrySeparator, sep);
+    }
+
+    public char getObjectFieldValueSeparator() {
+        return objectFieldValueSeparator;
+    }
+
+    public char getObjectEntrySeparator() {
+        return objectEntrySeparator;
+    }
+
+    public char getArrayValueSeparator() {
+        return arrayValueSeparator;
+    }
+}