Naming convention

From DarkWiki
Revision as of 09:01, 29 March 2019 by Apowney (talk | contribs) (Factories)
Jump to: navigation, search

Java naming convention

Getters and setters

  • Getters (get, is)
    • Takes no parameters
    • Does not alter the object in any way; it is constant
    • Can be called multiple times, and in any order
    • Returns a consistent single result
  • Setters (set)
    • Takes one parameter
    • May or may not alter the object
    • Only affects the object that has the setter; it does not persist anywhere else
    • Can be called multiple times, and in any order

Finders & filters

  • Finders (find)
    • Takes zero or more arguments (which act as filter or sorting controls)
    • Does not alter the object in any way; it is constant
    • Can be called multiple times, and in any order
    • Returns a consistent single, non-null collection result

Factories

  • Factories
    • Responsible for creating objects - not persisting them!
  • Factory classes
    • Conform to [ObjectType]Factory naming convention
  • Factory methods
    • Conform to create[ObjectType] naming convention

Persistance

  • Repositories
    • Conform to [ObjectType]Repository naming convention
    • Methods such as 'save*', 'load*', 'find*', 'read*', 'write*', 'delete*'