Documentation mistake on module auto-registration about jackson-modules-java8 HOT 8 CLOSED

Thank you for reporting this. I'll have a look.

from jackson-modules-java8.

Ah. I think I see what is happening here. What comment is trying to say is that the module auto-registered will be JSR310Module, due to entry in:

src/main/resources/META-INF/services/com.fasterxml.jackson.databind.Module

and that is the default due to legacy reasons. So it is correct in a way, although badly phrased.

I will change this in 3.0 to use the new module.

from jackson-modules-java8.

Updated javadoc a bit; fixed registration for master (3.0.0-SNAPSHOT)

from jackson-modules-java8.

Yeah, it was a bit badly phrased, but I understood it.

The problem I see is how the github documentation is. It doesn't explain that the legacy version is the one to be registered, it just says that the module can be auto-registered, so people will only know about this if they read the javadoc, the ones copying and pasting from the github website will get the legacy version without knowing.

from jackson-modules-java8.

The documentation says:

Usage
Registering module
Starting with Jackson 2.2, Modules can be automatically discovered using the Java 6 Service Provider Interface (SPI) feature. You can activate this by instructing an ObjectMapper to find and register all Modules:

ObjectMapper mapper = new ObjectMapper();
mapper.findAndRegisterModules();
You should use this feature with caution as it has performance implications. You should generally create one constant ObjectMapper instance for your entire application codebase to share, or otherwise use one of ObjectMapper's findModules methods and cache the result.

If you prefer to selectively register this module, this is done as follows, without the call to findAndRegisterModules():

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());
After either of these, functionality is available for all normal Jackson operations.

from jackson-modules-java8.

Oh. I did not check github README, only Javadocs. Thanks for pointing this out.

from jackson-modules-java8.

Updated README as well. Let me know if that still does not make sense, and/or you have suggestions for improvement.

from jackson-modules-java8.

There's a ; on another line, don't know if this was on purpose to "close" the ObjectMapper create, but besides this, it all looks perfectly clear for me now, thank you for taking the time!

from jackson-modules-java8.