search

FasterXML / jackson-databind

General data-binding package for Jackson (2.x): works on streaming API (core) implementation(s)
Apache License 2.0
3.52k stars 1.38k forks source link

Documentation request: details on auto-detecting getters/setters patterns #2201

Open sinaa opened 5 years ago

sinaa commented 5 years ago

The auto-detect ability of jackson is great such that object getters/setters are used to infer the fields and to map json to object / object to json.

However, we've faced many gotchas with this so far, and the documentation on the wiki https://github.com/FasterXML/jackson-databind/wiki/Mapper-Features don't make it really clear on how these auto-detect mechanisms work behind the curtain.

Would it be possible to expand the documentation on this front with some pattern examples? For example, I believe both isFoo() and getFoo() are supported, and I can't figure out whether there's a point in the docs I'm missing, or whether this is not clearly documented at all.

I'd be awesome if clear guidelines on these method signature patterns could be published.

cowtowncoder commented 5 years ago

I was about to consider the whole "It's Open Source, so..." answer, but then realized that this is actually a very good feature request! All that is needed (aside from someone having an itch and do this) is to figure out how to connect the specific request for concrete thing to write about (I have mental todo list of many, many things) with developers who might step up and help.

I'll start with something more manageable tho, and create a new issue label.