Skip to content

Commit c1d3ea7

Browse files
committed
Add Javadoc notes on some of entity renamings in Jackson 3.0
1 parent 2610a95 commit c1d3ea7

File tree

7 files changed

+1594
-1
lines changed

7 files changed

+1594
-1
lines changed

src/main/java/com/fasterxml/jackson/databind/AnnotationIntrospector.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1420,7 +1420,8 @@ public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated
14201420
* NOTE: naming of this method is unfortunately inconsistent in that "default Creator"
14211421
* has other meanings than "primary Creator" -- in other places Jackson code
14221422
* refers to no-arguments Constructors as "default Creators". So this method
1423-
* ought to have been named {@code findPrimaryCreator()}.
1423+
* ought to have been named {@code findPreferredCreator()} (and will in fact
1424+
* be renamed as such in Jackson 3.0).
14241425
*
14251426
* @param config Configuration settings in effect (for deserialization)
14261427
* @param valueClass Class being instantiated; defines Creators passed

src/main/java/com/fasterxml/jackson/databind/JsonSerializable.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
* Note that while it is possible to just directly implement {@link JsonSerializable},
1919
* actual implementations are strongly recommended to instead extend
2020
* {@link JsonSerializable.Base}.
21+
*<p>
22+
* NOTE: in Jackson 3.x this class will be renamed as {@code JacksonSerializable}
2123
*/
2224
public interface JsonSerializable
2325
{

src/main/java/com/fasterxml/jackson/databind/Module.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
* Simple interface for extensions that can be registered with {@link ObjectMapper}
2222
* to provide a well-defined set of extensions to default functionality; such as
2323
* support for new data types.
24+
*<p>
25+
* NOTE: in Jackson 3.x this class will be renamed as {@code JacksonModule}
26+
* to avoid naming conflict with JDK 9's {@code java.lang.module.Module}.
2427
*/
2528
public abstract class Module
2629
implements Versioned

src/main/java/com/fasterxml/jackson/databind/SerializerProvider.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@
4747
* {@link com.fasterxml.jackson.databind.ser.DefaultSerializerProvider}.
4848
* Only this instance can be used for actual serialization calls; blueprint
4949
* object is only to be used for creating instances.
50+
*<p>
51+
* NOTE: in Jackson 3.x this class will be renamed as {@code SerializationContext}
52+
* to align with {@link DeserializationContext}.
53+
*
5054
*/
5155
public abstract class SerializerProvider
5256
extends DatabindContext

0 commit comments

Comments
 (0)