Merge branch '2.x' into 3.x

Author: cowtowncoder

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORParser.java

@@ -130,7 +130,7 @@ public int getFirstTag() {
     /* Configuration
     /**********************************************************************
      */
-    
+
     /**
      * Bit flag composed of bits that indicate which
      * {@link CBORReadFeature}s are enabled.
@@ -1963,15 +1963,13 @@ private final byte[] _getBinaryFromString(Base64Variant variant) throws JacksonE
     }
 
     /**
-     * Checking whether the current token represents an `undefined` value (0xF7).
+     * Checking whether the current token represents an {@code undefined} value ({@code 0xF7}).
      * <p>
-     * This method allows distinguishing between real {@code null} and `undefined`,
-     * even if {@link CBORReadFeature#HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT} is disabled
+     * This method allows distinguishing between real {@code null} and {@code undefined},
+     * even if {@link CBORReadFeature#READ_UNDEFINED_AS_EMBEDDED_OBJECT} is disabled
      * and the token is reported as {@link JsonToken#VALUE_NULL}.
      *
-     * @return {@code true} if current token is an `undefined`, {@code false} otherwise
-     *
-     * @since 2.20
+     * @return {@code true} if current token is an {@code undefined}, {@code false} otherwise
      */
     public boolean isUndefined() {
         if ((_currToken == JsonToken.VALUE_NULL) || (_currToken == JsonToken.VALUE_EMBEDDED_OBJECT)) {
@@ -3679,19 +3677,9 @@ private final static long _long(int i1, int i2)
      * Helper method to encapsulate details of handling of mysterious `undefined` value
      * that is allowed to be used as something encoder could not handle (as per spec),
      * whatever the heck that should be.
-     * <p>
-     * For backward compatibility with Jackson 2.10 to 2.19, this value is decoded
-     * as {@link JsonToken#VALUE_NULL} by default.
-     * <p>
-     *
-     * since 2.20 If {@link CBORReadFeature#HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT} is enabled,
-     * the value will instead be decoded as {@link JsonToken#VALUE_EMBEDDED_OBJECT}
-     * with an embedded value of {@code null}.
-     *
-     * @since 2.10
      */
     protected JsonToken _decodeUndefinedValue() {
-        if (CBORReadFeature.HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT.enabledIn(_formatFeatures)) {
+        if (CBORReadFeature.READ_UNDEFINED_AS_EMBEDDED_OBJECT.enabledIn(_formatFeatures)) {
             _binaryValue = null; // should be clear but just in case
             return JsonToken.VALUE_EMBEDDED_OBJECT;
         }
@@ -3705,8 +3693,6 @@ protected JsonToken _decodeUndefinedValue() {
      * As of Jackson 2.12, simple values are exposed as
      * {@link JsonToken#VALUE_NUMBER_INT}s,
      * but in later versions this is planned to be changed to separate value type.
-     *
-     * @since 2.12
      */
     public JsonToken _decodeSimpleValue(int lowBits, int ch) throws JacksonException {
         if (lowBits > 24) {

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORReadFeature.java

@@ -28,18 +28,17 @@ public enum CBORReadFeature implements FormatFeature
     DECODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING(false),
 
     /**
-     * Feature that determines how an ` undefined ` value (0xF7) is decoded.
+     * Feature that determines how an {@code undefined} value ({@code 0xF7}) is exposed
+     * by parser.
      * <p>
-     * When enabled, the parser returns {@link JsonToken#VALUE_EMBEDDED_OBJECT} with a
-     * value of {@code null}, allowing the caller to distinguish `undefined` from actual
+     * When enabled, the parser returns {@link JsonToken#VALUE_EMBEDDED_OBJECT} with
+     * a value of {@code null}, allowing the caller to distinguish {@code undefined} from actual
      * {@link JsonToken#VALUE_NULL}.
+     * When disabled {@code undefined} value is reported as {@link JsonToken#VALUE_NULL}.
      *<p>
-     * When disabled (default, for backwards compatibility), `undefined` value is
-     * reported as {@link JsonToken#VALUE_NULL}, maintaining legacy behavior from Jackson 2.10 to 2.19.
-     *
-     * @since 2.20
+     * The default value is {@code false} for backwards compatibility (with versions prior to 2.20).
      */
-    HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT(false)
+    READ_UNDEFINED_AS_EMBEDDED_OBJECT(false)
     ;
 
     private final boolean _defaultState;

cbor/src/test/java/tools/jackson/dataformat/cbor/parse/UndefinedValueTest.java

@@ -35,7 +35,7 @@ public void testUndefinedLiteralStreaming() throws Exception
     @Test
     public void testUndefinedLiteralAsEmbeddedObject() throws Exception {
         CBORFactory f = CBORFactory.builder()
-                .enable(CBORReadFeature.HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT)
+                .enable(CBORReadFeature.READ_UNDEFINED_AS_EMBEDDED_OBJECT)
                 .build();
         CBORParser p = cborParser(f, new byte[] { BYTE_UNDEFINED });
 
@@ -65,7 +65,7 @@ public void testUndefinedInArray() throws Exception
     @Test
     public void testUndefinedInArrayAsEmbeddedObject() throws Exception {
         CBORFactory f = CBORFactory.builder()
-                .enable(CBORReadFeature.HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT)
+                .enable(CBORReadFeature.READ_UNDEFINED_AS_EMBEDDED_OBJECT)
                 .build();
 
         ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -111,7 +111,7 @@ public void testUndefinedInObject() throws Exception
     @Test
     public void testUndefinedInObjectAsEmbeddedObject() throws Exception {
         CBORFactory f = CBORFactory.builder()
-                .enable(CBORReadFeature.HANDLE_UNDEFINED_AS_EMBEDDED_OBJECT)
+                .enable(CBORReadFeature.READ_UNDEFINED_AS_EMBEDDED_OBJECT)
                 .build();
 
         ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -126,14 +126,14 @@ public void testUndefinedInObjectAsEmbeddedObject() throws Exception {
         // assume we use end marker for Object, so
         doc[doc.length - 2] = BYTE_UNDEFINED;
 
-        CBORParser p = cborParser(f, doc);
-        assertEquals(JsonToken.START_OBJECT, p.nextToken());
-        assertEquals(JsonToken.PROPERTY_NAME, p.nextToken());
-        assertEquals("bar", p.currentName());
-        assertEquals(JsonToken.VALUE_EMBEDDED_OBJECT, p.nextToken());
-        assertTrue(p.isUndefined());
-        assertEquals(JsonToken.END_OBJECT, p.nextToken());
-        assertNull(p.nextToken());
-        p.close();
+        try (CBORParser p = cborParser(f, doc)) {
+            assertEquals(JsonToken.START_OBJECT, p.nextToken());
+            assertEquals(JsonToken.PROPERTY_NAME, p.nextToken());
+            assertEquals("bar", p.currentName());
+            assertEquals(JsonToken.VALUE_EMBEDDED_OBJECT, p.nextToken());
+            assertTrue(p.isUndefined());
+            assertEquals(JsonToken.END_OBJECT, p.nextToken());
+            assertNull(p.nextToken());
+        }
     }
 }

release-notes/VERSION-2.x

@@ -18,8 +18,7 @@ Active maintainers:
 
 #137: (cbor) Allow exposing CBOR "undefined" value as `JsonToken.VALUE_EMBEDDED_OBJECT`;
   with embedded value of `null`
- (implementation contributed by Fawzi E) 
-  
+ (implementation contributed by Fawzi E)
 #431: (cbor) Negative `BigInteger` values not encoded/decoded correctly
  (reported by Brian G)
  (fix contributed by Fawzi E)