-
Notifications
You must be signed in to change notification settings - Fork 119
3. Coding Guidelines
Package names should use the company domain prefixes, org.pentaho
or com.pentaho
depending if it's a CE or EE project.
Api's should omit the api
token from package names. On the other hand, implementations should include the impl
token on the package name. A package name should look something like this:
package <org/com>.pentaho . <project-group> . [impl] . <package-suffix>;
As an example, an api class would live in the following package:
package org.pentaho . det . data.access.endpoints;
It's implementation(s) would be in:
package org.pentaho . det . impl . data.access.endpoints;
The presence of the impl token has additional consequences, as some tools use it as a reserved word to introduce behaviour. The maven-bundle-plugin is one of those cases, packages with impl
or internal
with not be included an Export-Package
.