Question

I have a User class that I want to map to JSON using Jackson.

public class User {
    private String name;
    private int age;
    private int securityCode;

    // getters and setters
}

I map this to a JSON string using –

User user = getUserFromDatabase();

ObjectMapper mapper = new ObjectMapper();   
String json =  mapper.writeValueAsString(user);

I don’t want to map the securityCode variable. Is there any way of configuring the mapper so that it ignores this field?

I know I can write custom data mappers or use the Streaming API but I would like to know if it possible to do it through configuration?

Answer 1

You have two options:

1. Jackson works on setters-getters of fields. So, you can just remove getter of field which you want to omit in JSON. ( If you don’t need getter at other place.)

2. Or, you can use the @JsonIgnore annotation of Jackson on getter method of that field and you see there in no such key-value pair in resulted JSON.

   @JsonIgnore
   public int getSecurityCode(){
      return securityCode;
   }