Java code convention for package names

Question

Possible Duplicate:
what is the convention for word separator in java package names?

I wonder if there are some code convension for package name which contains several words. E.g. package name com.dreamcom.objectInterfaces. Is camel case suitable in this case?

Solution 1

From Java package naming conventions @ Wikipedia (emphasis added):

Packages are usually defined using a hierarchical naming pattern, with levels in the hierarchy separated by periods (.) (pronounced "dot"). Although packages lower in the naming hierarchy are often referred to as "subpackages" of the corresponding packages higher in the hierarchy, there is almost no semantic relationship between packages. The Java Language Specification establishes package naming conventions to avoid the possibility of two published packages having the same name. The naming conventions describe how to create unique package names, so that packages that are widely distributed will have unique namespaces. This allows packages to be separately, easily and automatically installed and catalogued.

In general, a package name begins with the top level domain name of the organization and then the organization's domain and then any subdomains, listed in reverse order. The organization can then choose a specific name for its package. Package names should be all lowercase characters whenever possible.

For example, if an organization in Canada called MySoft creates a package to deal with fractions, naming the package ca.mysoft.fractions distinguishes the fractions package from another similar package created by another company. If a German company named MySoft also creates a fractions package, but names it de.mysoft.fractions, then the classes in these two packages are defined in a unique and separate namespace.

Complete conventions for disambiguating package names and rules for naming packages when the Internet domain name cannot be directly used as a package name are described in section 7.7 of the Java Language Specification.

---

See also:

• The Java Language Specification §7.7 Unique Package Names
• Do you really use your reverse domain for package naming in java?

Solution 2

The convention is to use lower case throughout.

More information is available in the JLS here.

Solution 3

Camel-casing package names is not something I like. With multiple words in a package name, I consider the following:

1. Isn't "com.dreamcom.interfaces" good enough?

2. Will "com.dreamcom.object.interfaces" work?

If not, then rather rather consider "com.dreamcom.objectinterfaces" than camel casing.

The reason for this is that package names mirrors directories on the host OS. On Linux "com.dreamcom.objectInterfaces" and "com.dreamcom.objectinterfaces" are distinct, while on Windows they are the same.

Comments

[Matt Ball]

The convention is to not use camel casing. I bolded the relevant part of the Wikipedia excerpt to make it more obvious.