]
Andre Dietisheim updated JBIDE-26164:
-------------------------------------
Labels: cleanup (was: )
internal packages are a mess
----------------------------
Key: JBIDE-26164
URL:
https://issues.jboss.org/browse/JBIDE-26164
Project: Tools (JBoss Tools)
Issue Type: Enhancement
Components: openshift
Affects Versions: 4.6.0.AM3
Reporter: Andre Dietisheim
Assignee: Andre Dietisheim
Priority: Minor
Labels: cleanup
Fix For: 4.9.0.AM2
Attachments: image-2018-07-04-15-42-01-395.png
Our package structure is a mess, especially internal ones are wrong.
Ex. org.jboss.tools.openshift ui:
There are 2 internal packages:
* org.jboss.tools.openshift.internal.ui
* org.jboss.tools.openshift.ui.internal
!image-2018-07-04-15-42-01-395.png!
Internal packages have to follow the base component name, which in our case is
org.jboss.tools.openshift:
* org.jboss.tools.openshift.internal.ui: *{color:green}CORRECT{color}*
* org.jboss.tools.openshift.ui.internal: *{color:red}WRONG{color}*
For the background:
*
https://wiki.eclipse.org/Naming_Conventions#Internal_Implementation_Packages:
{quote}
All implementation packages should be flagged as internal, with the tag occurring just
after the major package name
{quote}
*
http://wiki.eclipse.org/Naming_Conventions#Java_Packages
{quote}
org.eclipse.jdt.internal.core.compiler - Correct usage
org.eclipse.jdt.core.internal.compiler - Incorrect. internal should immediately follow
project name.
org.eclipse.core.internal.resources - Correct usage
org.eclipse.internal.core.resources - Incorrect. internal should never immediately
follow org.eclipse.
org.eclipse.core.resources.internal - Incorrect. internal should immediately follow
Eclipse Platform component name.
{quote}