@NotNull not supported on fields

[vguna]

Hi.

I'm using @NotNull to mark attributes as required. I tend to put these on the fields of a class. It seems that enunciate doesn't pick these up - unless they are specified on the getter. Could that be enhanced?

Another thing regarding this:

I've created my own annotation @NotBlank, that "inherits" @NotNull but also checks for empty strings using trim(). Would it make sense that enunciate also checks for any annotations on fields that "inherit" from @NotNull?

[stoicflame]

What do you mean when you say @NotBlank "inherits" @NotNull?

[vguna]

If you take a look at hibernate's @NotBlank, it defines behavior, that inherits from @NotNull. That means, if the field is only decorated with @NotBlank, it automatically checks for not null AND additionally if the string is empty.

For the client side documentation it would be nice, if it would be set to required if an annotation already "inherits" @NotNull. Otherwise one would always have to add the two annotations separately for each field.

But since this is a custom annotation anyway, maybe it's good enough to handle that with the freemarker templates and check explicitly for @NotBlank on my own?

@Documented
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@ReportAsSingleViolation
@NotNull
public @interface NotBlank {
    String message() default "{org.hibernate.validator.constraints.NotBlank.message}";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };

    /**
     * Defines several {@code @NotBlank} annotations on the same element.
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    public @interface List {
        NotBlank[] value();
    }
}

[stoicflame]

Fixed at defdba0.

Added support for detecting "inherited" @NotNull annotations (i.e. annotations that are themselves annotated with @NotNull).

[stoicflame]

Enunciate 2.4 has been released.

[ghost]

Works, thanks! But this doesn't contain support for annotations on fields, as it seems, right :)?

[stoicflame]

The problem is that you're expecting Enunciate to use annotations that are on the fields for the properties (getters/setters).

If the fields were getting used as accessors instead of the properties, Enunciate would pick up the @NotNull annotations. So you can either annotate the properties, or use @JsonAutoDetect to specify that the fields should be used for (de)serialization instead of the properties.

[ghost]

That means, that Enunciate is using jackson for reading annotations? Or does Enunciate evaluate the @JsonAutodetect by itself and acts accordingly?

[stoicflame]

Enunciate evaluates the annotation itself.

[ghost]

Now I'm confused ;). Enunciate has its own mechanism for finding/reading annotations. Ok. And Enunciate evaluates @JsonAutodetect to decide where to expect the annotations - either on fields or properties - as specified by that annotation?

[stoicflame]

Correct.