uPortal 3 Naming Conventions

uPortal developers are asked to follow the following naming conventions when writing new java classes and interfaces for uPortal 3 and beyond.

Java Interfaces

Java interfaces should begin with the letter I. 

Example: IPortletDefinition

Java Implementation Classes

When only one implementation is expected, use the term Impl. 

Example: PortletDefinitionImpl.

When more than one implementation is expected, use a name that describes the implementation. 

Example: SpringPortletDefinitionDao.

Names Including Acronyms

Avoid using acronyms in names whenever possible.  If an acronym must be used, make the first letter upper case and the remaining letters lower case. 

Example: JdbcPortletDefinitionDao.