[ 
https://issues.apache.org/jira/browse/SIS-587?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Martin Desruisseaux updated SIS-587:
------------------------------------
    Description: 
Apache SIS has a many packages for SIS internal usage. Users should not use the 
classes in those package, because they may change in any SIS version without 
notice. Prior to SIS 1.4, those packages were identified by naming conventions. 
Anything starting with {{org.apache.sis.internal.}} is excluded from Javadoc 
and should be ignored by users. However this convention is unconvenient for SIS 
developers, because the {{internal}} part in package name cause related package 
to appear far from each other. As SIS become bigger, the internal packages 
became more and more confusing.

Since JPMS modularisation, the {{internal}} naming convention is no longer 
needed. Instead the {{module-info.java}} file declare explicitly which packages 
are exported, and packages not in this list are invisible to users. 
Consequently we can rename the internal packages to something much closer to 
where they are used.

  was:
Apache SIS has a many packages for SIS internal usage. Users should not use the 
classes in those package, because they may change in any SIS version without 
notice. Prior to SIS 1.4, those packages were identified by naming conventions. 
Anything starting with {{org.apache.sis.internal.}} is excluded from Javadoc 
and should be ignored by users. However this convention is unconvenient for SIS 
developers, because the `internal` part in package name cause related package 
to appear far from each other. As SIS become bigger, the internal packages 
became more and more confusion.

Since JPMS modularisation, the {{internal}} naming convention is no longer 
needed. Instead the {{module-info.java}} file declare explicitly which packages 
are exported, and packages not in this list are invisible to users. 
Consequently we can rename the internal packages to something much closer to 
where they are used.


> Rename internal packages
> ------------------------
>
>                 Key: SIS-587
>                 URL: https://issues.apache.org/jira/browse/SIS-587
>             Project: Spatial Information Systems
>          Issue Type: Task
>          Components: Coverage, Features, Geometry, GUI, Metadata, Portrayal, 
> Referencing, Shapefile, Storage, Utilities
>    Affects Versions: 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 1.0, 1.1, 1.2, 1.3
>            Reporter: Martin Desruisseaux
>            Assignee: Martin Desruisseaux
>            Priority: Major
>             Fix For: 1.4
>
>         Attachments: ReplaceImports.xml
>
>
> Apache SIS has a many packages for SIS internal usage. Users should not use 
> the classes in those package, because they may change in any SIS version 
> without notice. Prior to SIS 1.4, those packages were identified by naming 
> conventions. Anything starting with {{org.apache.sis.internal.}} is excluded 
> from Javadoc and should be ignored by users. However this convention is 
> unconvenient for SIS developers, because the {{internal}} part in package 
> name cause related package to appear far from each other. As SIS become 
> bigger, the internal packages became more and more confusing.
> Since JPMS modularisation, the {{internal}} naming convention is no longer 
> needed. Instead the {{module-info.java}} file declare explicitly which 
> packages are exported, and packages not in this list are invisible to users. 
> Consequently we can rename the internal packages to something much closer to 
> where they are used.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to