Fix #2451

Author: cowtowncoder

release-notes/VERSION-2.x

@@ -15,6 +15,7 @@ Project: jackson-databind
  (reported, fix contributed by Hesham M)
 #2446: Java 11: Unable to load JDK7 types (annotations, java.nio.file.Path): no Java7 support added
  (reported by David C)
+#2451: Add new `JsonValueFormat` value, `UUID`
 
 2.10.0.pr2 (31-Aug-2019)
 

src/main/java/com/fasterxml/jackson/databind/jsonFormatVisitors/JsonValueFormat.java

@@ -74,7 +74,7 @@ public enum JsonValueFormat
     TIME("time"),
 
     /**
-     * This value SHOULD be a URI..
+     * This value SHOULD be a URI.
      */
     URI("uri"),
 
@@ -85,6 +85,13 @@ public enum JsonValueFormat
       float).
      */
     UTC_MILLISEC("utc-millisec"),
+
+    /**
+     * Value should be valid <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a>
+     *
+     * @since 2.10
+     */
+    UUID("uuid")
     ;
 
     private final String _desc;

src/main/java/com/fasterxml/jackson/databind/ser/std/UUIDSerializer.java

@@ -5,6 +5,8 @@
 
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat;
 import com.fasterxml.jackson.databind.util.TokenBuffer;
 
 /**
@@ -39,11 +41,10 @@ public void serialize(UUID value, JsonGenerator gen, SerializerProvider provider
     {
         // First: perhaps we could serialize it as raw binary data?
         if (gen.canWriteBinaryNatively()) {
-            /* 07-Dec-2013, tatu: One nasty case; that of TokenBuffer. While it can
-             *   technically retain binary data, we do not want to do use binary
-             *   with it, as that results in UUIDs getting converted to Base64 for
-             *   most conversions.
-             */
+            // 07-Dec-2013, tatu: One nasty case; that of TokenBuffer. While it can
+            //   technically retain binary data, we do not want to do use binary
+            //   with it, as that results in UUIDs getting converted to Base64 for
+            //   most conversions.
             if (!(gen instanceof TokenBuffer)) {
                 gen.writeBinary(_asBytes(value));
                 return;
@@ -72,12 +73,20 @@ public void serialize(UUID value, JsonGenerator gen, SerializerProvider provider
         gen.writeString(ch, 0, 36);
     }
 
+    // Need to add bit of extra info, format
+    @Override
+    public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
+        throws JsonMappingException
+    {
+        visitStringFormat(visitor, typeHint, JsonValueFormat.UUID);
+    }
+
     private static void _appendInt(int bits, char[] ch, int offset)
     {
         _appendShort(bits >> 16, ch, offset);
         _appendShort(bits, ch, offset+4);
     }
-    
+
     private static void _appendShort(int bits, char[] ch, int offset)
     {
         ch[offset] = HEX_CHARS[(bits >> 12) & 0xF];

src/test/java/com/fasterxml/jackson/databind/jsonschema/NewSchemaTest.java

@@ -202,8 +202,8 @@ public JsonMapFormatVisitor expectMapFormat(JavaType type) {
     /* Test methods
     /**********************************************************
      */
-    
-    private final ObjectMapper MAPPER = new ObjectMapper();
+
+    private final ObjectMapper MAPPER = newJsonMapper();
 
     /* Silly little test for simply triggering traversal, without attempting to
      * verify what is being reported. Smoke test that should trigger problems

src/test/java/com/fasterxml/jackson/databind/jsonschema/SchemaWithUUIDTest.java

@@ -0,0 +1,37 @@
+package com.fasterxml.jackson.databind.jsonschema;
+
+import java.util.Set;
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicReference;
+
+import com.fasterxml.jackson.databind.*;
+
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonStringFormatVisitor;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat;
+
+public class SchemaWithUUIDTest extends BaseMapTest
+{
+    private final ObjectMapper MAPPER = newJsonMapper();
+
+    public void testUUIDSchema() throws Exception
+    {
+        final AtomicReference<JsonValueFormat> format = new AtomicReference<>();
+
+        MAPPER.acceptJsonFormatVisitor(UUID.class, new JsonFormatVisitorWrapper.Base() {
+            @Override
+            public JsonStringFormatVisitor expectStringFormat(JavaType type) {
+                return new JsonStringFormatVisitor() {
+                    @Override
+                    public void enumTypes(Set<String> enums) { }
+
+                    @Override
+                    public void format(JsonValueFormat f) {
+                        format.set(f);
+                    }
+                };
+            }
+        });
+        assertEquals(JsonValueFormat.UUID, format.get());
+    }
+}