Skip to content

Commit

Permalink
Add Javadoc notes on some of entity renamings in Jackson 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
cowtowncoder committed Dec 6, 2024
1 parent 2610a95 commit c1d3ea7
Show file tree
Hide file tree
Showing 7 changed files with 1,594 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -1420,7 +1420,8 @@ public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated
* NOTE: naming of this method is unfortunately inconsistent in that "default Creator"
* has other meanings than "primary Creator" -- in other places Jackson code
* refers to no-arguments Constructors as "default Creators". So this method
* ought to have been named {@code findPrimaryCreator()}.
* ought to have been named {@code findPreferredCreator()} (and will in fact
* be renamed as such in Jackson 3.0).
*
* @param config Configuration settings in effect (for deserialization)
* @param valueClass Class being instantiated; defines Creators passed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
* Note that while it is possible to just directly implement {@link JsonSerializable},
* actual implementations are strongly recommended to instead extend
* {@link JsonSerializable.Base}.
*<p>
* NOTE: in Jackson 3.x this class will be renamed as {@code JacksonSerializable}
*/
public interface JsonSerializable
{
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/fasterxml/jackson/databind/Module.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
* Simple interface for extensions that can be registered with {@link ObjectMapper}
* to provide a well-defined set of extensions to default functionality; such as
* support for new data types.
*<p>
* NOTE: in Jackson 3.x this class will be renamed as {@code JacksonModule}
* to avoid naming conflict with JDK 9's {@code java.lang.module.Module}.
*/
public abstract class Module
implements Versioned
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@
* {@link com.fasterxml.jackson.databind.ser.DefaultSerializerProvider}.
* Only this instance can be used for actual serialization calls; blueprint
* object is only to be used for creating instances.
*<p>
* NOTE: in Jackson 3.x this class will be renamed as {@code SerializationContext}
* to align with {@link DeserializationContext}.
*
*/
public abstract class SerializerProvider
extends DatabindContext
Expand Down
Loading

0 comments on commit c1d3ea7

Please sign in to comment.