Merge pull request #17 from lpandzic/issue-13-readme.md

issue-13 readme md update

Author: cowtowncoder

README.md

@@ -35,10 +35,14 @@ So, after registering the module as described above, you will be able to use dat
 ```java
 class Person {
 
+    // mandatory fields
     private final String name;
     private final String surname;
+    
+    // optional fields
+    private String nickname;
 
-    @JsonCreator // important!
+    // no annotations are required if preconditions are met (details below)
     public Person(String name, String surname) {
 
         this.name = name;
@@ -52,14 +56,27 @@ class Person {
     public String getSurname() {
         return surname;
     }
+
+    public String getNickname() {
+
+        return nickname;
+    }
+
+    public void setNickname(String nickname) {
+
+        this.nickname = nickname;
+    }
 }
 ```
-class Person must be compiled with Java 8 compliant compiler with the enabled option to store formal parameter names (`-parameters` option). For more information about Java 8 API for accessing parameter names at runtime see [this][2].
 
+Preconditions:
+
+  - class Person must be compiled with Java 8 compliant compiler with option to store formal parameter names turned on (`-parameters` option). For more information about Java 8 API for accessing parameter names at runtime see [this][2]
+  - if there are multiple visible constructors and there is no default constructor, @JsonCreator is required to select constructor for deserialization
 
 ## More
 
 See [Wiki](../../wiki) for more information (javadocs, downloads).
 
 [1]: http://jackson.codehaus.org/1.1.2/javadoc/org/codehaus/jackson/annotate/JsonProperty.html
-[2]: http://docs.oracle.com/javase/tutorial/reflect/member/methodparameterreflection.html
+[2]: http://docs.oracle.com/javase/tutorial/reflect/member/methodparameterreflection.html

pom.xml

@@ -37,7 +37,7 @@ introspection of method/constructor parameter names, without having to add expli
     <!-- Generate PackageVersion.java into this directory. -->
     <packageVersion.dir>com/fasterxml/jackson/module/paramnames</packageVersion.dir>
     <packageVersion.package>${project.groupId}.paramnames</packageVersion.package>
-    <assertj-core.version>1.7.1</assertj-core.version>
+    <assertj-core.version>2.0.0</assertj-core.version>
 
     <!-- Configuration properties for the OSGi maven-bundle-plugin -->
     <osgi.import>com.fasterxml.jackson.core

src/test/java/com/fasterxml/jackson/module/paramnames/Person.java

@@ -0,0 +1,36 @@
+package com.fasterxml.jackson.module.paramnames;
+
+class Person {
+
+    // mandatory fields
+    private final String name;
+    private final String surname;
+
+    // optional fields
+    private String nickname;
+
+    // no annotations are required if preconditions are met (details below)
+    public Person(String name, String surname) {
+
+        this.name = name;
+        this.surname = surname;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getSurname() {
+        return surname;
+    }
+
+    public String getNickname() {
+
+        return nickname;
+    }
+
+    public void setNickname(String nickname) {
+
+        this.nickname = nickname;
+    }
+}

src/test/java/com/fasterxml/jackson/module/paramnames/PersonTest.java

@@ -0,0 +1,28 @@
+package com.fasterxml.jackson.module.paramnames;
+
+import static org.assertj.core.api.BDDAssertions.then;
+
+import java.io.IOException;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.Test;
+
+public class PersonTest {
+
+    @Test
+    public void shouldBeAbleToDeserializePerson() throws IOException {
+
+        // given
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.registerModule(new ParameterNamesModule());
+
+        // when
+        Person actual = objectMapper.readValue("{\"name\":\"joe\",\"surname\":\"smith\",\"nickname\":\"joey\"}", Person.class);
+
+        // then
+        Person expected = new Person("joe", "smith");
+        expected.setNickname("joey");
+        then(actual).isEqualToComparingFieldByField(expected);
+
+    }
+}