Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Development Resources/HOWTO/The Eclipse Code Namespace Policy"

Line 7: Line 7:
 
  org.<forge>.<shortname>.<component>.*
 
  org.<forge>.<shortname>.<component>.*
 
Where:
 
Where:
* ''forge'' is the short name of the hosting forge, e.g. "eclipse", "locationtech", or "polarsys";
+
* ''forge'' is the short name of the hosting [[Forges|forge]], e.g. "eclipse", "locationtech", or "polarsys";
 
* ''shortname'' is the short name of the project (i.e. the last segment of the project id), e.g. "dali", "egit", "udig"; and
 
* ''shortname'' is the short name of the project (i.e. the last segment of the project id), e.g. "dali", "egit", "udig"; and
 
* ''component'' is project-specific
 
* ''component'' is project-specific

Revision as of 15:58, 5 February 2014

Eclipse projects must carefully manage their namespaces in order to help identify the producer of components and avoid namespace collisions.

Exceptions to these guidelines must be approved by the Project Management Committee and the EMO.

Java Package Names

Java package names take the standard reverse DNS form:

org.<forge>.<shortname>.<component>.*

Where:

  • forge is the short name of the hosting forge, e.g. "eclipse", "locationtech", or "polarsys";
  • shortname is the short name of the project (i.e. the last segment of the project id), e.g. "dali", "egit", "udig"; and
  • component is project-specific

Multiple component segments are permitted.

Examples:

  • org.eclipse.emf.core, org.eclipse.emf.edit, org.eclipse.emf.edit.ui; and
  • org.locationtech.udig.resources

Java package names use the "flat" or "short" project name in the third segment; they should not include, for example, the name of the top-level project or any parent/container project.

  • e.g. org.eclipse.graphiti.core, not org.eclipse.modeling.mdt.graphiti.core or org.eclipse.mdt.graphiti.core.

OSGi Bundle Names

OSGi Bundle names follow the same rules as Java Package Names.

Java Archive (JAR/WAR/EAR) Names

TBD

JavaScript

TBD


This page is moderated by the EMO.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.