Fix #3037 (rename Module as JacksonModule)

Author: cowtowncoder

release-notes/VERSION

@@ -43,5 +43,6 @@ Versions: 3.x (for earlier see VERSION-2.x)
 #2828: Add `DatabindException` as intermediate subtype of `JsonMappingException`
 #3028: Change `UUIDSerializer` to use `StreamWriteCapability` check instead of
   `JsonGenerator.canWriteBinaryNatively()`
+#3037: Rename `Module` as `JacksonModule` in 3.0 (to avoid overlap with `java.lang.Module`)
 - Remove `MappingJsonFactory`
 - Add context parameter for `TypeSerializer` contextualization (`forProperty()`)

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

@@ -19,8 +19,11 @@
  * 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: was named just {@code Module} in Jackson 2.x but renamed due to naming
+ * conflict with Java 9+ {@code java.lang.Module}
  */
-public abstract class Module
+public abstract class JacksonModule
     implements Versioned
 {
     /*
@@ -44,7 +47,7 @@ public abstract class Module
     public abstract Version version();
 
     /**
-     * Method that returns an id that may be used to determine if two {@link Module}
+     * Method that returns an id that may be used to determine if two {@link JacksonModule}
      * instances are considered to be of same type, for purpose of preventing
      * multiple registrations of "same" module,
      *<p>
@@ -62,7 +65,7 @@ public Object getRegistrationId() {
      * Modules returned will be registered before this module is registered,
      * in iteration order.
      */
-    public Iterable<? extends Module> getDependencies() {
+    public Iterable<? extends JacksonModule> getDependencies() {
         return Collections.emptyList();
     }
 

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

@@ -51,7 +51,7 @@
  * Former starts with default configuration (same as one that no-arguments constructor
  * created mapper has), and latter starts with configuration of the mapper it is called
  * on.
- * In both cases, after configuration (including addition of {@link Module}s) is complete,
+ * In both cases, after configuration (including addition of {@link JacksonModule}s) is complete,
  * instance is created by calling {@link MapperBuilder#build()} method.
  *<p>
  * Mapper (and {@link ObjectReader}s, {@link ObjectWriter}s it constructs) will
@@ -553,12 +553,12 @@ public boolean isEnabled(SerializationFeature f) {
      */
 
     /**
-     * Method that may be used to find out {@link Module}s that were registered
+     * Method that may be used to find out {@link JacksonModule}s that were registered
      * when creating this mapper (if any).
      *
      * @since 3.0
      */
-    public Collection<com.fasterxml.jackson.databind.Module> getRegisteredModules() {
+    public Collection<JacksonModule> getRegisteredModules() {
         return _savedBuilderState.modules();
     }
 

src/main/java/com/fasterxml/jackson/databind/cfg/MapperBuilder.java

@@ -101,7 +101,7 @@ public abstract class MapperBuilder<M extends ObjectMapper,
     /**
      * Modules registered for addition, indexed by registration id.
      */
-    protected Map<Object, com.fasterxml.jackson.databind.Module> _modules;
+    protected Map<Object, JacksonModule> _modules;
 
     /*
     /**********************************************************************
@@ -351,8 +351,8 @@ protected MapperBuilder(MapperBuilderState state)
             _modules = null;
         } else {
             _modules = new LinkedHashMap<>();
-            for (Object mod : state._modules) {
-                addModule((com.fasterxml.jackson.databind.Module) mod);
+            for (JacksonModule mod : state._modules) {
+                addModule(mod);
             }
         }
     }
@@ -979,11 +979,11 @@ public B removeAllModules() {
     /**
      * Method will add given module to be registered when mapper is built, possibly
      * replacing an earlier instance of the module (as specified by its
-     * {@link Module#getRegistrationId()}).
+     * {@link JacksonModule#getRegistrationId()}).
      * Actual registration occurs in addition order (considering last add to count,
      * in case of re-registration for same id) when {@link #build()} is called.
      */
-    public B addModule(com.fasterxml.jackson.databind.Module module)
+    public B addModule(JacksonModule module)
     {
         _verifyModuleMetadata(module);
         final Object moduleId = module.getRegistrationId();
@@ -998,15 +998,15 @@ public B addModule(com.fasterxml.jackson.databind.Module module)
 
         // 10-Sep-2019, tatu: [databind#2432] Module dependencies; need to add first
         //   but unlike main module, do NOT replace module if already added
-        for (com.fasterxml.jackson.databind.Module dep : module.getDependencies()) {
+        for (JacksonModule dep : module.getDependencies()) {
             _verifyModuleMetadata(dep);
             _modules.putIfAbsent(dep.getRegistrationId(), dep);
         }
         _modules.put(moduleId, module);
         return _this();
     }
 
-    private void _verifyModuleMetadata(com.fasterxml.jackson.databind.Module module)
+    private void _verifyModuleMetadata(JacksonModule module)
     {
         if (module.getModuleName() == null) {
             throw new IllegalArgumentException("Module ("+module.getClass().getName()+") without defined name");
@@ -1016,17 +1016,17 @@ private void _verifyModuleMetadata(com.fasterxml.jackson.databind.Module module)
         }
     }
 
-    public B addModules(com.fasterxml.jackson.databind.Module... modules)
+    public B addModules(JacksonModule... modules)
     {
-        for (com.fasterxml.jackson.databind.Module module : modules) {
+        for (JacksonModule module : modules) {
             addModule(module);
         }
         return _this();
     }
 
-    public B addModules(Iterable<? extends com.fasterxml.jackson.databind.Module> modules)
+    public B addModules(Iterable<? extends JacksonModule> modules)
     {
-        for (com.fasterxml.jackson.databind.Module module : modules) {
+        for (JacksonModule module : modules) {
             addModule(module);
         }
         return _this();
@@ -1039,7 +1039,7 @@ public B addModules(Iterable<? extends com.fasterxml.jackson.databind.Module> mo
      * Note that method does not do any caching, so calls should be considered
      * potentially expensive.
      */
-    public static List<com.fasterxml.jackson.databind.Module> findModules() {
+    public static List<JacksonModule> findModules() {
         return findModules(null);
     }
 
@@ -1050,11 +1050,11 @@ public static List<com.fasterxml.jackson.databind.Module> findModules() {
      * Note that method does not do any caching, so calls should be considered
      * potentially expensive.
      */
-    public static List<com.fasterxml.jackson.databind.Module> findModules(ClassLoader classLoader)
+    public static List<JacksonModule> findModules(ClassLoader classLoader)
     {
-        ArrayList<com.fasterxml.jackson.databind.Module> modules = new ArrayList<>();
-        ServiceLoader<com.fasterxml.jackson.databind.Module> loader = secureGetServiceLoader(com.fasterxml.jackson.databind.Module.class, classLoader);
-        for (com.fasterxml.jackson.databind.Module module : loader) {
+        ArrayList<JacksonModule> modules = new ArrayList<>();
+        ServiceLoader<JacksonModule> loader = secureGetServiceLoader(JacksonModule.class, classLoader);
+        for (JacksonModule module : loader) {
             modules.add(module);
         }
         return modules;
@@ -1093,7 +1093,7 @@ public B findAndAddModules() {
      * "Accessor" method that will expose set of registered modules, in addition
      * order, to given handler.
      */
-    public B withModules(Consumer<com.fasterxml.jackson.databind.Module> handler) {
+    public B withModules(Consumer<JacksonModule> handler) {
         if (_modules != null) {
             _modules.values().forEach(handler);
         }

src/main/java/com/fasterxml/jackson/databind/cfg/MapperBuilderState.java

@@ -64,7 +64,7 @@ public abstract class MapperBuilderState
     /**
      * Modules registered in registration order, if any; `null` if none.
      */
-    protected final com.fasterxml.jackson.databind.Module[] _modules;
+    protected final JacksonModule[] _modules;
 
     /*
     /**********************************************************************
@@ -177,12 +177,12 @@ public MapperBuilderState(MapperBuilder<?,?> src)
         }
     }
 
-    private static com.fasterxml.jackson.databind.Module[] _toArray(Collection<?> coll)
+    private static JacksonModule[] _toArray(Collection<?> coll)
     {
         if (coll == null || coll.isEmpty()) {
             return null;
         }
-        return coll.toArray(new com.fasterxml.jackson.databind.Module[0]);
+        return coll.toArray(new JacksonModule[0]);
     }
 
     /*
@@ -191,7 +191,7 @@ private static com.fasterxml.jackson.databind.Module[] _toArray(Collection<?> co
     /**********************************************************************
      */
 
-    public Collection<com.fasterxml.jackson.databind.Module> modules() {
+    public Collection<JacksonModule> modules() {
         if (_modules == null) {
             return Collections.emptyList();
         }

src/main/java/com/fasterxml/jackson/databind/cfg/ModuleContextBase.java

@@ -6,7 +6,7 @@
 import com.fasterxml.jackson.core.*;
 
 import com.fasterxml.jackson.databind.*;
-import com.fasterxml.jackson.databind.Module.SetupContext;
+import com.fasterxml.jackson.databind.JacksonModule.SetupContext;
 import com.fasterxml.jackson.databind.deser.*;
 import com.fasterxml.jackson.databind.jsontype.NamedType;
 import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
@@ -16,7 +16,7 @@
 import com.fasterxml.jackson.databind.type.TypeModifier;
 
 public class ModuleContextBase
-    implements SetupContext
+    implements JacksonModule.SetupContext
 {
     // // // Immutable objects we need to access information
 

src/main/java/com/fasterxml/jackson/databind/cfg/MutableConfigOverride.java

@@ -9,11 +9,9 @@
 /**
  * Extension of {@link ConfigOverride} that allows changing of
  * contained configuration settings. Exposed to
- * {@link com.fasterxml.jackson.databind.Module}s that want to set
+ * {@link com.fasterxml.jackson.databind.JacksonModule}s that want to set
  * overrides, but not exposed to functionality that wants to apply
  * overrides.
- *
- * @since 2.8
  */
 public class MutableConfigOverride
     extends ConfigOverride

src/main/java/com/fasterxml/jackson/databind/deser/DeserializerFactory.java

@@ -127,7 +127,7 @@ public abstract KeyDeserializer createKeyDeserializer(DeserializationContext ctx
      * Method that can be used to check if databind module has explicitly declared deserializer
      * for given (likely JDK) type, explicit meaning that there is specific deserializer for
      * given type as opposed to auto-generated "Bean" deserializer. Factory itself will check
-     * for known JDK-provided types, but registered {@link com.fasterxml.jackson.databind.Module}s
+     * for known JDK-provided types, but registered {@link com.fasterxml.jackson.databind.JacksonModule}s
      * are also called to see if they might provide explicit deserializer.
      *<p> 
      * Main use for this method is with Safe Default Typing (and generally Safe Polymorphic

src/main/java/com/fasterxml/jackson/databind/jsontype/BasicPolymorphicTypeValidator.java

@@ -294,7 +294,7 @@ public boolean match(DatabindContext ctxt, Class<?> clazz) {
          * Method for appending matcher that will allow all subtypes for which a
          * {@link com.fasterxml.jackson.databind.JsonDeserializer})
          * is explicitly provided by either {@code jackson-databind} itself or one of registered
-         * {@link com.fasterxml.jackson.databind.Module}s.
+         * {@link com.fasterxml.jackson.databind.JacksonModule}s.
          * Determination is implementation by calling
          * {@link com.fasterxml.jackson.databind.deser.DeserializerFactory#hasExplicitDeserializerFor}.
          *<p>

src/main/java/com/fasterxml/jackson/databind/module/SimpleModule.java

@@ -11,7 +11,7 @@
 import com.fasterxml.jackson.databind.util.UniqueId;
 
 /**
- * Vanilla {@link Module} implementation that allows registration
+ * Vanilla {@link JacksonModule} implementation that allows registration
  * of serializers and deserializers, bean serializer
  * and deserializer modifiers, registration of subtypes and mix-ins
  * as well as some other commonly
@@ -34,7 +34,7 @@
  * signatures (with {@link JavaType}).
  */
 public class SimpleModule
-    extends com.fasterxml.jackson.databind.Module
+    extends JacksonModule
     implements java.io.Serializable
 {
     private static final long serialVersionUID = 3L;

src/main/java/com/fasterxml/jackson/databind/module/package-info.java

@@ -1,6 +1,6 @@
 /**
  * Package that contains classes and interfaces to help implement
- * custom extension {@link com.fasterxml.jackson.databind.Module}s
+ * custom extension {@link com.fasterxml.jackson.databind.JacksonModule}s
  * (which are registered on ObjectMapper via builders}.
  *<p>
  * Note that classes in the package only support registering

src/test/java/com/fasterxml/jackson/databind/ObjectMapperTest.java

@@ -271,7 +271,7 @@ public Object getRegistrationId() {
 
         final SimpleModule mainModule = new SimpleModule() {
             @Override
-            public Iterable<? extends Module> getDependencies() {
+            public Iterable<? extends JacksonModule> getDependencies() {
                 return Arrays.asList(secondModule, thirdModule);
             }
 
@@ -285,7 +285,7 @@ public Object getRegistrationId() {
                 .addModule(mainModule)
                 .build();
 
-        Collection<Module> mods = objectMapper.getRegisteredModules();
+        Collection<JacksonModule> mods = objectMapper.getRegisteredModules();
         List<Object> ids = mods.stream().map(mod -> mod.getRegistrationId())
                 .collect(Collectors.toList());
         assertEquals(Arrays.asList("dep1", "dep2", "main"), ids);

src/test/java/com/fasterxml/jackson/databind/deser/builder/BuilderSimpleTest.java

@@ -243,7 +243,7 @@ public ValueClass822(int x, Map<String,Object> stuff) {
         }
     }
 
-    protected static class NopModule1557 extends com.fasterxml.jackson.databind.Module
+    protected static class NopModule1557 extends com.fasterxml.jackson.databind.JacksonModule
     {
         @Override
         public String getModuleName() {

src/test/java/com/fasterxml/jackson/databind/deser/creators/NullValueViaCreatorTest.java

@@ -55,7 +55,7 @@ public boolean hasDeserializerFor(DeserializationConfig config,
         }
     }
 
-    protected static class TestModule extends com.fasterxml.jackson.databind.Module
+    protected static class TestModule extends com.fasterxml.jackson.databind.JacksonModule
     {
         @Override
         public String getModuleName() {

src/test/java/com/fasterxml/jackson/databind/module/SimpleModuleTest.java

@@ -298,7 +298,7 @@ public void testGetRegisteredModules()
                 .addModule(mod2)
                 .build();
 
-        List<com.fasterxml.jackson.databind.Module> mods = new ArrayList<>(mapper.getRegisteredModules());
+        List<JacksonModule> mods = new ArrayList<>(mapper.getRegisteredModules());
         assertEquals(2, mods.size());
         // Should retain ordering even if not mandated
         assertEquals("test1", mods.get(0).getModuleName());
@@ -331,7 +331,7 @@ public void testMixIns() throws Exception
 
     public void testAccessToMapper() throws Exception
     {
-        com.fasterxml.jackson.databind.Module module = new com.fasterxml.jackson.databind.Module()
+        final JacksonModule module = new JacksonModule()
         {
             @Override
             public String getModuleName() { return "x"; }

src/test/java/com/fasterxml/jackson/databind/module/TestDuplicateRegistration.java

@@ -7,7 +7,7 @@
 
 public class TestDuplicateRegistration extends BaseMapTest
 {
-    static class MyModule extends com.fasterxml.jackson.databind.Module {
+    static class MyModule extends JacksonModule {
         private final AtomicInteger counter;
         private final Object id;