@JsonIncludeProperties and @JsonPropertyOrder could be combined

[marceloverdijk]

I was experimenting a bit with the @JsonIncludeProperties introduced recently.

It would be nice if it would automatically apply the property order instead of having to include @JsonPropertyOrder as well.

Now we need:

@JsonIncludeProperties({
        "id",
        "code",
        "name"
})
@JsonPropertyOrder({
        "id",
        "code",
        "name"
})
public class Continent {

}

[cowtowncoder]

Hmmh. Interesting idea, I like it.

Will have to think about how this should be achieved, semantics probably cannot be changed by automatically using it (unless this would have the lowest priority? Or maybe not even then).
But adding a new OptBoolean property (order?) could work, allow easy opt-in.

[marceloverdijk]

I'm glad you like the idea and even targeting it for the next release!

Indeed I was thinking of providing a Boolean as well if for some reason automatically is not an option.

[marceloverdijk]

Maybe orderProperties is a better name as it is more consistent with @JsonOrderProperties?

[cowtowncoder]

Possibly? I think annotation is @JsonPropertyOrder fwtw.

And the reason to use OptBoolean is just because annotations do not have option of "optional boolean": enum properties can only be left optional with a default setting: and with boolean there is no way to then indicate whether setting is from defaults or explicit. This is a problem with some annotations already; especially in cases where there is 3-level hierarchy (global -> type -> property); specifically, cannot enable "fail on unknown properties".

[marceloverdijk]

Yes you are of course right it is @JsonPropertyOrder.
So maybe something like below then:

@JsonIncludeProperties(order = OptBoolean.TRUE, value = {
        "id",
        "code",
        "name"
})
public class Continent {

}

I think indeed order is sufficient ;-)