blob: 24f70e96e4fa393943c1c15e1b901f96215c4a68 [file] [log] [blame]
Tatu Saloranta55bfa002012-05-14 22:49:54 -07001Version: 2.1.0
Tatu Saloranta703bf4a2012-01-11 22:14:37 -08002
3Release date:
Tatu Salorantac2776412012-05-14 19:40:57 -07004 xx-Jun-2012
Tatu Saloranta703bf4a2012-01-11 22:14:37 -08005
6Description:
Tatu Saloranta55bfa002012-05-14 22:49:54 -07007 New minor version for 2.x.
Tatu Salorantac2776412012-05-14 19:40:57 -07008
9Fixes:
10
Tatu Saloranta01006e32012-08-24 14:35:55 -070011* [JACKSON-830]/[Issue#19]: Change OSGi bundle name to be fully-qualified
Tatu Salorantae8c1b532012-08-29 11:49:21 -070012* ]JACKSON-847]: Make @JsonIdentityInfo work with property-based creator
Tatu Salorantabc483d12012-08-01 23:35:59 -070013* [JACKSON-851]: State corruption with ObjectWriter, DefaultPrettyPrinter
14 (reported by Duncan A)
Tatu Saloranta8075bfa2012-09-29 22:55:20 -070015* [Issue#75]: Too aggressive KeySerializer caching
Tatu Saloranta01006e32012-08-24 14:35:55 -070016* Minor fix wrt [Issue#11], coercion needed extra checks
Tatu Salorantafcbce112012-06-28 14:43:43 -070017
Tatu Salorantace7398c2012-05-30 20:45:03 -070018Improvements:
19
Tatu Salorantaac1f2ab2012-08-01 19:49:20 -070020* [JACKSON-758]: Remove 'IOException' from throws clauses of "writeValueAsString"
21 and "writeValueAsBytes" of ObjectMapper/ObjectWriter
22 (suggested by G-T Chen)
Tatu Salorantace7398c2012-05-30 20:45:03 -070023* [JACKSON-839]: Allow "upgrade" of integer number types for
24 UntypedObjectDeserializer, even with default typing enabled.
Tatu Saloranta11cec4d2012-07-22 22:33:20 -070025* [JACKSON-850]: Allow use of zero-arg factory methods as "default creator"
26 (suggested by Razvan D)
Tatu Saloranta7ccce012012-08-04 16:17:54 -070027* [Issue#9]: Implement 'required' JSON Schema attribute for bean properties
28* [Issue#20]: Add new exception type, InvalidFormatException (sub-type of
Tatu Salorantadd348562012-07-18 17:25:02 -070029 JsonMappingException) to indicate data format problems
30 (suggested by HolySamosa@github)
Tatu Saloranta2aa6dc82012-08-29 23:06:06 -070031* [Issue#30]: ObjectReader and ObjectWriter now try to pre-fetch root
Tatu Saloranta15d6ea22012-08-03 18:29:23 -070032 (de)serializer if possible; minor performance improvement (2% for small POJOs).
Tatu Saloranta2aa6dc82012-08-29 23:06:06 -070033* [Issue#33]: Simplified/clarified definition of 'ObjectReader.readValues()';
Tatu Salorantaa12061f2012-07-20 21:42:26 -070034 minor change in behavior for JSON Array "wrapped" sequences
Tatu Saloranta2aa6dc82012-08-29 23:06:06 -070035* [Issue#60]: Add 'JsonNode.hasNonNull(...)' method(s)
36 (suggested by Jeff S on mailing list)
Tatu Salorantaeb4e6b12012-08-30 19:02:17 -070037* [Issue#64]: Add new "standard" PropertyNamingStrategy, PascalCaseStrategy
38 (PropertyNamingStrategy.PASCAL_CASE_TO_CAMEL_CASE)
39 (contributed by Sean B)
Tatu Saloranta0dc8dec2012-09-06 17:08:29 -070040* [Issue#65]: Add getters to `ObjectMapper`, DeserializationContext/-Factory.
41 (contributed by Dmitry K)
Tatu Salorantaab374c72012-09-04 22:10:52 -070042* [Issue#69]: Add `PropertyName` abstraction, new methods in AnnotationIntrospector
Tatu Salorantace7398c2012-05-30 20:45:03 -070043
Tatu Saloranta6cada0a2012-07-31 22:24:03 -070044New features:
45
Tatu Salorantad163f5e2012-08-20 16:49:15 -070046* [Issue#15]: Support data format auto-detection via ObjectReader (added
47 'withFormatDetection(...)' fluent factories)
Tatu Saloranta767cead2012-08-13 16:27:45 -070048* [Issue#21]: Add 'ObjectNode.set(...)' method (and related) to improve
49 chaining, semantic consistency of Tree Model API
50 (suggested by fge@Github)
Tatu Saloranta7ccce012012-08-04 16:17:54 -070051* [Issue#22]: Add 'ObjectMapper.setAnnotationIntrospectors()' which allows
Tatu Saloranta15d6ea22012-08-03 18:29:23 -070052 defining different introspectors for serialization, deserialization
Tatu Saloranta7ccce012012-08-04 16:17:54 -070053* [Issue#24]: Allow serialization of Enums as JSON Objects
Tatu Saloranta15d6ea22012-08-03 18:29:23 -070054 (suggested by rveloso@github)
Tatu Saloranta7ccce012012-08-04 16:17:54 -070055* [Issue#28]: Add 'ObjectMapper.copy()', to create non-linked copy of
56 mapper, with same configuration settings
57* [Issue#29]: Allow serializing, deserializing POJOs as JSON Arrays
Tatu Saloranta6cada0a2012-07-31 22:24:03 -070058 by using `@JsonFormat(shape=Shape.ARRAY)`
Tatu Saloranta7ccce012012-08-04 16:17:54 -070059* [Issue#40]: Allow serialization of Collections as JSON Objects
Tatu Saloranta15d6ea22012-08-03 18:29:23 -070060 (and deserialization from)
Tatu Saloranta8d2cdd72012-08-13 23:10:51 -070061 (suggested by 'rveloso@github')
62* [Issue#42]: Allow specifying Base64 variant to use for Base64-encoded data
63 using ObjectReader.with(Base64Variant), ObjectWriter.with(Base64Variant).
64 (suggested by 'mpfau@github')
Tatu Saloranta023d8bd2012-08-13 22:17:28 -070065* [Issue#45]: Add '@JsonNaming' annotation to define per-class PropertyNamingStrategy
66 (suggested by Mark W)
Tatu Saloranta45267962012-08-28 10:10:43 -070067* [Pull#58]: Make 'MappingIterator' implement 'Closable'
68 (contributed by Pascal G)
Tatu Salorantaf412e852012-09-11 22:05:51 -070069* [Issue#72]: Add 'MapperFeature.USE_WRAPPER_NAME_AS_PROPERTY_NAME' to use
70 wrapper name annotations for renaming properties
Tatu Saloranta88040e22012-08-24 13:33:00 -070071* (issue #4 of jackson-annotations): Add `@JsonIdentityReference(alwaysAsId=true)`
Tatu Saloranta6cada0a2012-07-31 22:24:03 -070072 to force ALL references to an object written as Object Id, even the first one.
Tatu Saloranta15d6ea22012-08-03 18:29:23 -070073* Added 'ObjectReader#withHandler' to allow for reconfiguring deserialization
74 problem handler
75 (suggested by 'electricmonk')
Tatu Saloranta6cada0a2012-07-31 22:24:03 -070076
Tatu Saloranta2b4086a2012-06-29 20:27:24 -070077Other changes:
78
79* New variant of AnnotationIntrospector.getFormat(), to support class
80 annotations
Tatu Saloranta134d3562012-07-05 21:38:46 -070081* It is now possible to serialize instances of plain old Object, iff
82 'FAIL_ON_EMPTY_BEANS' is disabled.
Tatu Saloranta9b847962012-09-11 15:16:41 -070083* Trying to remove reference to "JSON" in datatype conversion errors
84 (since databinding is format-agnostic)
Tatu Saloranta2b4086a2012-06-29 20:27:24 -070085
Tatu Salorantaa12061f2012-07-20 21:42:26 -070086INCOMPATIBILITIES: (rats!)
87
Tatu Saloranta7ccce012012-08-04 16:17:54 -070088* Note that [Issue#33] (see above) is, technically speaking, backwards
Tatu Salorantaa12061f2012-07-20 21:42:26 -070089 imcompatible change. It is estimated that it should NOT affect most
90 users, as changes are to edge cases (and undocumented ones at that).
91 However, it can potentially cause problems with upgrade.
92
Tatu Salorantac2776412012-05-14 19:40:57 -070093------------------------------------------------------------------------
94=== History: ===
95------------------------------------------------------------------------
96
Tatu Salorantaa12061f2012-07-20 21:42:26 -0700972.0.4 (26-Jun-2012)
98
Tatu Saloranta7ccce012012-08-04 16:17:54 -070099* [Issue#6]: element count for PrettyPrinter, endObject wrong
Tatu Salorantaa12061f2012-07-20 21:42:26 -0700100 (reported by "thebluemountain")
101* [JACKSON-838]: Utf8StreamParser._reportInvalidToken() skips letters
102 from reported token name
Tatu Saloranta023d8bd2012-08-13 22:17:28 -0700103 (reported by Lóránt Pintér)
Tatu Salorantaa12061f2012-07-20 21:42:26 -0700104* [JACKSON-841] Data is doubled in SegmentedStringWriter output
105 (reported by Scott S)
106* [JACKSON-842] ArrayIndexOutOfBoundsException when skipping C-style comments
107 (reported by Sebastien R)
108
1092.0.3: no version 2.0.3 released -- only used for extension modules
110
Tatu Salorantac2776412012-05-14 19:40:57 -07001112.0.2 [14-May-2012]
Tatu Saloranta23e267c2012-04-23 19:22:04 -0700112
113Fixes:
114
Tatu Saloranta7ccce012012-08-04 16:17:54 -0700115* [Issue#14]: Annotations were not included from parent classes of
Tatu Saloranta1b30b1a2012-04-28 00:43:34 -0700116 mix-in classes
117 (reported by @guillaup)
Tatu Salorantae16034e2012-04-30 22:51:36 -0700118* [JACKSON-824]: Combination of JSON Views, ObjectMapper.readerForUpdating()
119 was not working
120 (reported by Nir S)
Tatu Salorantab8f79ed2012-05-14 19:04:53 -0700121(and all fixes from 1.9.7)
Tatu Saloranta1b30b1a2012-04-28 00:43:34 -0700122
Tatu Salorantacfa2fc12012-04-27 19:31:28 -0700123Improvements:
124
Tatu Saloranta7ccce012012-08-04 16:17:54 -0700125* [Issue#11]: Improve ObjectMapper.convertValue()/.treeToValue() to use
Tatu Salorantacfa2fc12012-04-27 19:31:28 -0700126 cast if possible
127
Tatu Saloranta23e267c2012-04-23 19:22:04 -07001282.0.1 [23-Apr-2012]
Tatu Saloranta737ad052012-04-02 21:04:47 -0700129
130Fixes:
131
Tatu Salorantafc3db392012-04-23 18:49:08 -0700132* [JACKSON-827] Ensure core packages work on JDK 1.5
133 (reported by Pascal g)
Tatu Salorantaae4ea6e2012-04-19 19:47:53 -0700134* [JACKSON-829] Custom serializers not working for List<String> properties,
135 @JsonSerialize(contentUsing)
136 (reported by James R)
137
Tatu Saloranta737ad052012-04-02 21:04:47 -0700138Improvements:
139
Tatu Saloranta7ccce012012-08-04 16:17:54 -0700140* [Issue#5]: Add support for maps with java.util.Locale keys to the set of
Tatu Saloranta737ad052012-04-02 21:04:47 -0700141 StdKeyDeserializers
142 (contributed by Ryan G)
143
Tatu Salorantafc3db392012-04-23 18:49:08 -07001442.0.0 [25-Mar-2012]
Tatu Saloranta703bf4a2012-01-11 22:14:37 -0800145
146Fixes:
147
Tatu Saloranta337feca2012-03-19 19:11:21 -0700148* [JACKSON-368]: Problems with managed references, abstract types
Tatu3af61ff2012-01-19 15:58:41 -0800149* [JACKSON-711]: Delegating @JsonCreator did not work with Injectable values
Tatu Salorantae1ceccd2012-03-04 19:52:36 -0800150* [JACKSON-798]: Problem with external type id, creators
151 (reported by Casey L)
Tatu Salorantadeaee9c2012-03-25 12:01:34 -0700152(and all fixes up until and including 1.9.6)
Tatu9e6c28f2012-01-19 15:58:08 -0800153
Tatu Salorantae1ceccd2012-03-04 19:52:36 -0800154Improvements:
Tatu Saloranta703bf4a2012-01-11 22:14:37 -0800155
Tatu Saloranta28ff1a92012-01-17 17:54:51 -0800156* [JACKSON-546]: Indicate end-of-input with JsonMappingException instead
157 of EOFException, when there is no parsing exception
Tatu Salorantaee6e3d12012-01-17 17:28:39 -0800158* [JACKSON-664]: Reduce overhead of type resolution by adding caching
159 in TypeFactory
Tatu Saloranta7555fa22012-01-14 23:03:04 -0800160* [JACKSON-690]: Pass DeserializationContext through ValueInstantiator
Tatu418a2392012-01-12 21:52:07 -0800161* [JACKSON-695]: Add 'isEmpty(value)' in JsonSerializer to allow
162 customizing handling of serialization of empty values
Tatu Saloranta15fb6ff2012-01-14 10:31:35 -0800163* [JACKSON-710]: 'ObjectMapper.convertValue()' should ignore root value
164 wrapping/unwrapping settings
Tatu60668262012-01-19 14:21:12 -0800165* [JACKSON-730] Split various features (JsonParser, JsonGenerator,
166 SerializationConfig, DeserializationConfig) into per-factory
Tatu Saloranta048832d2012-03-09 21:48:40 -0800167 features (MapperFeature, JsonFactory.Feature) an per
Tatu60668262012-01-19 14:21:12 -0800168 instance features (existing ones)
Tatu Salorantaa03e0eb2012-01-14 14:01:39 -0800169* [JACKSON-732]: Allow 'AnnotationIntrospector.findContentDeserializer()'
170 (and similar) to return instance, not just Class<?> for instance
171 (requested by James R)
Tatu Saloranta4b02e9e2012-02-03 18:41:29 -0800172* [JACKSON-736]: Add (more) access to array, container and map serializers
Tatu Salorantac166fa32012-02-03 19:42:41 -0800173* [JACKSON-737]: Allow accessing of "creator properties" for BeanDeserializer
Tatucbbfbd32012-01-20 16:07:51 -0800174* [JACKSON-748]: Add 'registerSubtypes' to 'Module.setupContext' (and SimpleModule)
Tatu Saloranta703bf4a2012-01-11 22:14:37 -0800175* [JACKSON-749]: Make @JsonValue work for Enum deserialization
Tatub471a042012-01-27 11:51:39 -0800176* [JACKSON-769]: ObjectNode/ArrayNode: change 'put', 'insert', 'add' to return
177 'this node' (unless already returning something)
Tatu Salorantae5d77692012-01-29 11:20:26 -0800178* [JACKSON-770]: Simplify method naming for JsonNode, drop unnecessary 'get' prefix
179 from methods like 'getTextValue()' (becomes 'textValue()')
Tatu9610aff2012-02-02 11:30:08 -0800180* [JACKSON-777]: Rename 'SerializationConfig.Feature' as 'SerializationFeature',
Tatu Saloranta28808722012-02-24 18:35:50 -0800181 'DeserializationConfig.Feature' as 'DeserializationFeature'
Tatu Salorantadfc4c882012-02-11 13:54:27 -0800182* [JACKSON-780]: MissingNode, NullNode should return 'defaultValue' from 'asXxx' methods,
Tatu Saloranta28808722012-02-24 18:35:50 -0800183 (not 0 for numbers), as they are not numeric types
Tatu Saloranta3ae9c392012-05-18 16:45:47 -0700184* [JACKSON-787]: Allow use of @JsonIgnoreProperties for properties (fields, getters, setters)
Tatu Saloranta28808722012-02-24 18:35:50 -0800185* [JACKSON-795]: @JsonValue was not working for Maps, Collections
Tatu Salorantacf5d5472012-03-03 11:47:51 -0800186* [JACKSON-800]: Add 'Module.SetupContext#addDeserializationProblemHandler'
187 (suggested by James R)
Tatu Saloranta703bf4a2012-01-11 22:14:37 -0800188
189New features:
190
Tatu Salorantac99a7842012-02-22 18:09:00 -0800191* [JACKSON-107]: Add support for Object Identity (to handled cycles, shared refs),
Tatu Salorantadeaee9c2012-03-25 12:01:34 -0700192 with @JsonIdentityInfo
Tatu Saloranta26b2e1b2012-02-22 22:50:21 -0800193* [JACKSON-435]: Allow per-property Date formatting using @JsonFormat.
Tatu Saloranta89580482012-01-20 22:08:56 -0800194* [JACKSON-437]: Allow injecting of type id as POJO property, by setting
195 new '@JsonTypeInfo.visible' property to true.
Tatu Saloranta17ad21f2012-02-19 10:01:31 -0800196* [JACKSON-469]: Support "Builder pattern" for deserialiation; that is, allow
197 use of separate Builder object for data binding, creating actual value
Tatu Saloranta7324b9b2012-02-02 21:51:16 -0800198* [JACKSON-608]: Allow use of JSON Views for deserialization
Tatu Saloranta49117e02012-03-03 16:01:12 -0800199* [JACKSON-636]: Add 'SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS' to allow
200 forced sorting of Maps during serialization
201 (suggested by Joern H)
Tatu Saloranta2aa64842012-01-14 22:25:08 -0800202* [JACKSON-669]: Allow prefix/suffix for @JsonUnwrapped properties
203 (requested by Aner P)
Tatu Salorantaf0e232d2012-01-29 16:44:28 -0800204* [JACKSON-707]: Add 'JsonNode.deepCopy()', to create safe deep copies
205 of ObjectNodes, ArrayNodes.
Tatu Salorantaff8c08c2012-02-21 22:21:21 -0800206* [JACKSON-714]: Add general-purpose @JsonFormat annotation
Tatubc4153e2012-01-18 15:05:44 -0800207* [JACKSON-718]: Added 'JsonNode.canConvertToInt()', 'JsonNode.canConvertToLong()'
Tatu Saloranta048832d2012-03-09 21:48:40 -0800208* [JACKSON-747]: Allow changing of 'SerializationFeature' for ObjectWriter,
209 'DeserializationFeature' for ObjectReader.
Tatu Saloranta2aa64842012-01-14 22:25:08 -0800210* [JACKSON-752]: Add @JsonInclude (replacement of @JsonSerialize.include)
Tatu Salorantaf7c45bf2012-01-16 18:26:47 -0800211* [JACKSON-754]: Add @JacksonAnnotationsInside for creating "annotation
212 bundles" (also: AnnotationIntrospector.isAnnotationBundle())
Tatubbebf462012-02-03 17:44:31 -0800213* [JACKSON-762]: Allow using @JsonTypeId to specify property to use as
214 type id, instead of using separate type id resolver.
Tatu Salorantae1961742012-01-22 16:03:47 -0800215* [JACKSON-764]: Allow specifying "root name" to use for root wrapping
216 via ObjectReader, ObjectWriter.
Tatu Saloranta361c0a82012-02-24 18:16:29 -0800217* [JACKSON-772]: Add 'JsonNode.withArray()' to use for traversing Array nodes.
218* [JACKSON-793]: Add support for configurable Locale, TimeZone to use
219 (via SerializationConfig, DeserializationConfig)
Tatu Saloranta048832d2012-03-09 21:48:40 -0800220* [JACKSON-805]: Add 'SerializationFeature.WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED'
221 to improve interoperability with BadgerFish/Jettison
Tatu Salorantaf293cc42012-03-24 21:10:18 -0700222* [JACKSON-810]: Deserialization Feature: Allow unknown Enum values via
223 'DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL'
224 (suggested by Raymond R)
Tatu Saloranta33a9a932012-03-21 18:12:14 -0700225* [JACKSON-813]: Add '@JsonSerializableSchema.id' attribute, to indicate
226 'id' value to add to generated JSON Schemas.
Tatu Saloranta2aa64842012-01-14 22:25:08 -0800227
Tatu Saloranta703bf4a2012-01-11 22:14:37 -0800228[entries for versions 1.x and earlier not retained; refer to earlier releases)