Feature request: @JsonbView

[nimo23]

It would be great to have something like jacksons @JsonView in Json-B, maybe it can be called @JsonbView. It should work like the following example:

// enums to discriminate between different json views
public enum UserSubset{
    MY_SUBSET_1, 
    MY_SUBSET_2;
}

// the user class
public class User {

    private int id;

    @JsonbView("mysubset1")
    private String name;

    // UserSubset.MY_SUBSET_1 => UserSubset.MY_SUBSET_1.name() = "mysubset1"
    @JsonbView(UserSubset.MY_SUBSET_1)
    private Task task;
}

// the task class
public class Task {

    private int id;

    // property will be (de)serialized in mysubset1, mysubset2 and the default one
    @JsonbView("mysubset1, mysubset2")
    private String description;
}

The value of @JsonbView is a common (array of) String or Enum which is used as a discriminator. Using something like

jsonb.toJson(user, "mysubset");
or
jsonb.toJson(user, UserSubset.MY_SUBSET_1);

will outut the json with only the properties annotated with @JsonbView("mysubset1") or @JsonbView(UserSubset.MY_SUBSET_1)

Is something like this already planned?

I think it would be an extremely useful and simple approach to declare various JSON subviews quickly, easily and cleanly.

[hantsy]

I would like it is a type-safe to ref the view definition like Jackson View support in Spring. https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/jackson.html

Define views by interfaces.

public class Views {
        public static class Public {}
        public static class Internal extends Public {}
        public static class Admin extends Internal {}
    }

Apply to the data modle class.

public class User {
        @JsonbView(Views.Public.class)
        private Long id;

        @JsonbView(Views.Public.class)
        private String username;

        @JsonbView(Views.Internal.class)
        private String email;

        @JsonbView(Views.Admin.class)
        private String ssn; // Sensitive data
    }

Use it by hard-code like.

jsonb.toJson(user, Views.Admin.class);

Or in the Jakarta REST resources.

@JsonbView(Views.Admin.class)
public users(){}

It is more flexible,

1. Support inheritance.
2. Type-safe reference in codes.

[rmannibucau]

open question: how different it is to make the model implementing an interface (read attributes - getter or read methods for records - only) and map with the interface as runtime api today? At JAX-RS level it is a matter of ensuring JAX-RS uses the signature type as runtime type in Jsonb API. So think it is covered already even if support if maybe not that great in practise so no need of JSON-B updates. Side note it has another design advantage, you decouple the model and contract view in a better, more strongly typed and less fragile way.