Difference between revisions of "Naming convention"

Revision as of 13:57, 8 February 2020

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

public String getName() {
  return this.name;
}

public boolean isAdult() {
  return true;
}

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

public void setName(String name) {
  this.name = name;
}

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 (or an empty Optional) - never null

Factories
- Responsible for creating objects - not persisting them!
- Are stateless

Populator methods (imbue)
- Only modify the object(s) passed as arguments
- Does not affect the object's state

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

@@ Line 8: / Line 8: @@
 ** Can be called multiple times, and in any order
 ** Returns a consistent single result
+<syntaxhighlight lang="java">
+public String getName() {
+  return this.name;
+}
+public boolean isAdult() {
+  return true;
+}
+</syntaxhighlight>
 * Setters (set)
@@ Line 15: / Line 26: @@
 ** Can be called multiple times, and in any order
-<syntaxhighlight lang="java" >
+<syntaxhighlight lang="java">
-public String getName() {
+public void setName(String name) {
-   return this.name;
+   this.name = name;
 }
 </syntaxhighlight>