Merge branch '2.14' into double-parser

Author: pjfanning

release-notes/CREDITS-2.x

@@ -303,3 +303,7 @@ Illia Ovchynnikov (wingsofovnia@github)
   * Reported #759: JsonGenerator to provide current value to the context before
    starting objects
   (2.14.0)
+
+Evan Galpin (egalpin@github)
+  * Contributed #762: Make `JsonPointer` `java.io.Serializable`
+  (2.14.0)

release-notes/VERSION-2.x

@@ -32,6 +32,8 @@ JSON library.
  (contributed by @pjfanning)
 #759: JsonGenerator to provide current value to the context before starting objects
  (reported by Illia O)
+#762: Make `JsonPointer` `java.io.Serializable`
+ (contributed by Evan G)
 #763: `JsonFactory.createParser()` with `File` may leak `InputStream`s
 #764: `JsonFactory.createGenerator()` with `File` may leak `OutputStream`s
 

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

@@ -1,6 +1,12 @@
 package com.fasterxml.jackson.core;
 
 import com.fasterxml.jackson.core.io.NumberInput;
+import java.io.Externalizable;
+import java.io.IOException;
+import java.io.ObjectInput;
+import java.io.ObjectOutput;
+import java.io.ObjectStreamException;
+import java.io.Serializable;
 
 /**
  * Implementation of
@@ -17,8 +23,10 @@
  *
  * @since 2.3
  */
-public class JsonPointer
+public class JsonPointer implements Serializable
 {
+    private static final long serialVersionUID = 1L; 
+
     /**
      * Character used to separate segments.
      *
@@ -59,7 +67,7 @@ public class JsonPointer
      * so that {@link #toString} should be as efficient as possible.
      */
     protected final String _asString;
-    
+
     protected final String _matchingPropertyName;
 
     protected final int _matchingElementIndex;
@@ -69,7 +77,7 @@ public class JsonPointer
     /* Construction
     /**********************************************************
      */
-    
+
     /**
      * Constructor used for creating "empty" instance, used to represent
      * state that matches current node.
@@ -517,7 +525,7 @@ public JsonPointer head() {
         if (!(o instanceof JsonPointer)) return false;
         return _asString.equals(((JsonPointer) o)._asString);
     }
-    
+
     /*
     /**********************************************************
     /* Internal methods
@@ -643,4 +651,47 @@ private static void _appendEscape(StringBuilder sb, char c) {
         }
         sb.append(c);
     }
+
+    /*
+    /**********************************************************
+    /* Support for JDK serialization (2.14+)
+    /**********************************************************
+     */
+
+    // Since 2.14: needed for efficient JDK serializability
+    private Object writeReplace() {
+        return new Serialization(_asString);
+    }
+
+    /**
+     * This must only exist to allow both final properties and implementation of
+     * Externalizable/Serializable for JsonPointer
+     *
+     * @since 2.14
+     */
+    static class Serialization implements Externalizable
+    {
+        private String _asString;
+
+        public Serialization() { }
+
+        Serialization(String asString) {
+            _asString = asString;
+        }
+
+        @Override
+        public void writeExternal(ObjectOutput out) throws IOException {
+            out.writeUTF(_asString);
+        }
+
+        @Override
+        public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+            _asString = in.readUTF();
+        }
+
+        private Object readResolve() throws ObjectStreamException {
+            // NOTE: method handles canonicalization of "empty":
+            return compile(_asString);
+        }
+    }
 }

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

@@ -216,6 +216,12 @@ protected InputStream _optimizedStreamFromURL(URL url) throws IOException {
      * Helper methods used for constructing an {@link InputStream} for
      * parsers to use, when input is to be read from given {@link File}.
      *
+     * @param f File to open stream for
+     *
+     * @return {@link InputStream} constructed
+     *
+     * @throws IOException If there is a problem opening the stream
+     *
      * @since 2.14
      */
     protected InputStream _fileInputStream(File f) throws IOException {
@@ -226,6 +232,12 @@ protected InputStream _fileInputStream(File f) throws IOException {
      * Helper methods used for constructing an {@link OutputStream} for
      * generator to use, when target is to be written into given {@link File}.
      *
+     * @param f File to open stream for
+     *
+     * @return {@link OutputStream} constructed
+     *
+     * @throws IOException If there is a problem opening the stream
+     *
      * @since 2.14
      */
     protected OutputStream _fileOutputStream(File f) throws IOException {

src/main/java/com/fasterxml/jackson/core/io/doubleparser/package-info.java

@@ -5,9 +5,7 @@
  *     <dd>Copyright (c) Werner Randelshofer. Apache 2.0 License.
  *         <a href="https://github.com/wrandelshofer/FastDoubleParser">github.com</a>.</dd>
  * </dl>
- */
-
-/**
+ *
  * Provides parsers that parse a {@code FloatValue} from a
  * {@link java.lang.CharSequence}, {@code char} array, or {@code byte} array
  * ({@code str});.
@@ -123,5 +121,7 @@
  *     <dd><a href="https://docs.oracle.com/javase/specs/jls/se18/html/jls-3.html#jls-3.10.2">docs.oracle.com</a></dd>
  * </dl>
  * </p>
+ *
+ * @since 2.14
  */
 package com.fasterxml.jackson.core.io.doubleparser;

src/test/java/com/fasterxml/jackson/core/TestJDKSerializability.java

@@ -10,6 +10,12 @@
  */
 public class TestJDKSerializability extends BaseTest
 {
+    /*
+    /**********************************************************************
+    /* Main factory type(s)
+    /**********************************************************************
+     */
+
     public void testJsonFactorySerializable() throws Exception
     {
         JsonFactory f = new JsonFactory();
@@ -26,6 +32,12 @@ public void testJsonFactorySerializable() throws Exception
         assertEquals(origJson, _copyJson(f2, origJson, true));
     }
 
+    /*
+    /**********************************************************************
+    /* Parser-related types
+    /**********************************************************************
+     */
+
     public void testBase64Variant() throws Exception
     {
         {
@@ -92,6 +104,12 @@ public void testSourceReference() throws Exception
         assertSame(ref2, ContentReference.unknown());
     }
 
+    /*
+    /**********************************************************************
+    /* Exception types
+    /**********************************************************************
+     */
+
     public void testParseException() throws Exception
     {
         JsonFactory jf = new JsonFactory();
@@ -127,7 +145,34 @@ public void testGenerationException() throws Exception
         JsonGenerationException result = jdkDeserialize(stuff);
         assertNotNull(result);
     }
-    
+
+    /*
+    /**********************************************************************
+    /* Misc other types
+    /**********************************************************************
+     */
+
+    public void testPointerSerializationNonEmpty() throws Exception
+    {
+        // First, see that we can write and read a general JsonPointer
+        final String INPUT = "/Image/15/name";
+        JsonPointer original = JsonPointer.compile(INPUT);
+        byte[] ser = jdkSerialize(original);
+        JsonPointer copy = jdkDeserialize(ser);
+        assertNotSame(copy, original);
+        assertEquals(original, copy);
+    }
+
+    public void testPointerSerializationEmpty() throws Exception
+    {
+        // and then verify that "empty" instance gets canonicalized
+        final JsonPointer emptyP = JsonPointer.empty();
+        byte[] ser = jdkSerialize(emptyP);
+        JsonPointer result = jdkDeserialize(ser);
+        assertSame("Should get same 'empty' instance when JDK serialize+deserialize",
+                emptyP, result);
+    }
+
     /*
     /**********************************************************
     /* Helper methods