Concrete collection type used in method declaration JAVA-W1065
Anti-pattern
Major
a year ago
—
a year old
Method
getHand returns an instance of a concrete collection type28 public void setBet(int amount) {
29 betAmount = amount;
30 }
31 public ArrayList<Card> getHand() {32 return hand;33 }34 public void clearHand() {
35 hand.clear();
36 }Method
getDeck returns an instance of a concrete collection type15 public void shuffle() {
16 Collections.shuffle(cards);
17 }
18 public ArrayList<Card> getDeck() {19 return cards;20 }21 /**
22 * Gets specifed card based off of index
23 * @param cardIndex
Description
Concrete collection types (such as ArrayList, HashMap, etc.) should not be used in a public method's signature.
Java encourages the use of abstract types/interfaces at the API boundary over concrete types. This helps one design generic APIs that are easy to modify and extend.
Although designing generic APIs is generally preferable, one should especially emphasize their use over concrete types when elements of the collection API are involved. This is because almost all non-trivial Java applications depend heavily on abstract types defined in Java's collection framework.
Bad Practice
// Return type is `ArrayList` instead of `List`.
public ArrayList<Integer> method() {
// ..rest of the code
}
// Parameter type is `HashMap` instead of `Map`.
public void methodWithParams(HashMap<String, String> demo) {
// ..rest of the code
}
Recommended
Consider using abstract types in return values and parameters of public methods.
public List<Integer> method() {
// ..rest of the code
}
public void methodWithParams(Map<String, String> demo) {
// ..rest of the code
}
References
- StackOverflow - Why we should use interface instead of concrete types?
- Oracle Java Documentation - Polymorphism