[hibernate-issues] [Hibernate-JIRA] Commented: (HSEARCH-746) Split API, SPI and private classes into separate packages

[Sanne Grinovero (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HSEARCH-746?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=42761#action_42761 ] 

Sanne Grinovero commented on HSEARCH-746:
-----------------------------------------

{quote}Another question: FSDirectoryProvider and co used to be public before we introduced directory provider shortcuts (ram, filesystem, filesystem-master, filesystem-slave, infinispan).
Should we keep them public or move them to a impl package?{quote}
I think it's fine having them as impl. That's what they are after all. Also discouraging the direct class name usage might make it easier to add alternative variants and then swith default implementations at a later time for a specific type (like mapping "ram" to a different one at some point without switching classnames which would be awful)

> Split API, SPI and private classes into separate packages
> ---------------------------------------------------------
>
>                 Key: HSEARCH-746
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HSEARCH-746
>             Project: Hibernate Search
>          Issue Type: New Feature
>          Components: analyzer, directory provider, documentation, engine, integration, mapping, massindexer, optimizer, query
>            Reporter: Emmanuel Bernard
>            Assignee: Emmanuel Bernard
>             Fix For: 4.0.0.Alpha1
>
>
> API should go into a functionally named package
> SPI should go into a functionally named package .spi eg org.hibernate.search.bridge.spi
> private classes should go into a functionally named package .impl eg org.hibernate.search.bridge.impl
> Note that the distinction between API and SPI is a bit blurry and needs to be refined by the team as a whole:
>  - is it any "public" API not directly called by the user application (ie a Bridge would be SPI). That's the definition followed by the Hibernate Core team.
>  - is it any API targeted at frameworks integrating with Hibernate Search as opposed to APIs (eg SearchConfiguration)

-- 
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