[hibernate-issues] [Hibernate-JIRA] Commented: (HV-442) Make clear in the documentation which types are supported for built-in constraints

Gunnar Morling (JIRA) noreply at atlassian.com
Tue Apr 19 17:41:59 EDT 2011


    [ http://opensource.atlassian.com/projects/hibernate/browse/HV-442?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=42108#action_42108 ] 

Gunnar Morling commented on HV-442:
-----------------------------------

{quote}
Just deprecating classes MaxValidatorForString etc will of course not make it much easier for the user, since normally this are not classes you code against directly. 
{quote}
Good point. The only way I see is adding a deprecation note to the table with supported types in the reference guide.

{quote}
On the other hand DecimalMin and DecimalMax support strings.
{quote}
Hmmm, that's right. I guess when using DecimalMin/-Max on strings people typically know/expect that this relates to the number represented by the string and not its length opposed to when using Min/Max. If you feel like we can also keep this, then we just have to update the docs. Just let me know what you prefer, I'll update the reference guide then (I think you must update the web page).

> Make clear in the documentation which types are supported for built-in constraints
> ----------------------------------------------------------------------------------
>
>                 Key: HV-442
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HV-442
>             Project: Hibernate Validator
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 4.1.0.Final
>            Reporter: Gunnar Morling
>             Fix For: 4.2.0.CR1
>
>
> Hibernate Validator supports the standard constraints defined in the Bean Validation AP at more types than required by the specification. E.g. @Min/@Max are supported for Strings, which is beyond what's defined in the spec.
> In order to avoid irritations we should make clear in the documentation (http://docs.jboss.org/hibernate/validator/4.1/reference/en-US/html/validator-usingvalidator.html#validator-defineconstraints-builtin) which types are supported by HV in addition to the BV specification (for @Past/@Future we already do describe this for the Joda types for example).
> Furthermore the annotation processor documentation says (reference guide and web site):
> {quote}
> Have you ever caught yourself by unintentionally doing things like
> annotating Strings with @Min to specify a minimum length (instead of using @Size)
> ...?
> Then the Hibernate Validator Annotation Processor is the right thing for you.
> {quote}
> This example is misleading, as the AP won't mark this situation as an erronous (the described misunderstanding, that @Min would refer to the String length can still happen, though).
> This issue is based on a post in the HV forum (https://forum.hibernate.org/viewtopic.php?f=9&t=1009701).

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


More information about the hibernate-issues mailing list