[hibernate-issues] [Hibernate-JIRA] Commented: (HV-484) Refactor package organisation to clearly separate spi, public and private APIs

[Gunnar Morling (JIRA)]

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

Gunnar Morling commented on HV-484:
-----------------------------------

Discussed this with Hardy. The structure should look like this:

{code}
org.hibernate.validator
 |
 |_api
 | |_cfg
 | |_constraints
 | |_messageinterpolation
 | |_method
 |
 |_spi
 | |_group
 | |_resourceloading (whould likely have to be split up into api/spi parts)
 |
 |_internal
  |_engine
  |_metadata
  |_util
  |_xml
{code}

We'll split the refactoring into two steps, a compatible one in 4.3, a breaking one in 5.0. 

In 4.3 we'll move all packages declared as private per the package JavaDoc to the {internal} package. This change shouldn't affect any clients only using the public API of HV as documented in the JavaDocs and the reference guide.

In 5.0 we'll then split the public API into the {{api}} and {{spi}} packages. This change will break existing clients, so it should be part of a major release.

> Refactor package organisation to clearly separate spi, public and private APIs
> ------------------------------------------------------------------------------
>
>                 Key: HV-484
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HV-484
>             Project: Hibernate Validator
>          Issue Type: Task
>          Components: engine
>    Affects Versions: 4.1.0.CR1
>            Reporter: Hardy Ferentschik
>             Fix For: 4.3.0.next
>
>
> Aligning with the other Hibernate projects.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira