Method and field names must be dissimilar JAVA-W1006
Anti-pattern
Minor
2 years ago
—
2 years old
This field and method MultiThreadHelperClassWaiter.complete have very similar names
59
60 public static class MultiThreadHelperClassWaiter {
61 public Object instance;
62 private volatile boolean complete = false;63
64 protected void on_complete() {
65 complete = true;This field and method MultiThreadHelperLambdaWaiter.complete have very similar names
44 }
45
46 public static class MultiThreadHelperLambdaWaiter {
47 private volatile boolean complete = false;48
49 protected void on_complete() {
50 complete = true;This field and method UnparsedHexNumber.intValue have very similar names
6class UnparsedHexNumber extends Number {
7 private final String number;
8 private boolean hasIntValue;
9 private int intValue; 10 private boolean hasLongValue;
11 private long longValue;
12 private boolean hasFloatValue;This field and method UnparsedHexNumber.floatValue have very similar names
10 private boolean hasLongValue;
11 private long longValue;
12 private boolean hasFloatValue;
13 private float floatValue; 14 private boolean hasDoubleValue;
15 private double doubleValue;
16 private BigInteger bigIntValue;This field and method UnparsedHexNumber.floatValue have very similar names
10 private boolean hasLongValue;
11 private long longValue;
12 private boolean hasFloatValue;
13 private float floatValue; 14 private boolean hasDoubleValue;
15 private double doubleValue;
16 private BigInteger bigIntValue;
Description
This class's method names are the same as its field names, or differ from the field names only in terms of capitalization. This will cause confusion when reading the code, and will also decrease readability.
Rename the similar fields or methods so that their names are more readily distinguishable.
Bad Practice
class SomeClass {
private String name;
private int age;
// This method seems to be a getter for the age field, but it does not return the value of age...
public int age() {
return 5;
}
// This could be mistaken for the age field's getter...
public String Age() {
return "stone";
}
private boolean isSomething;
// can be confusing. At first glance, this may be mistaken to be a getter, but it is actually a setter!
public void something(boolean newVal) {
isSomething = newVal;
}
public void doIt() {
// ...
}
}
class SomeChildClass extends SomeClass {
// What does this string represent?
// There are already two methods and one field with names similar to this one.
String Age;
// This method may be an overload for the doIt method in the parent class,
// but it is spelled differently than the parent method... was this intentional?
public String doit(String arg1, int arg2) {
// ...
}
}
Recommended
Name fields based on the value they represent. Never name a field with the same name as a different field or method.
Name methods based on the actions they are meant to perform, and ensure that their names can't be mistaken for that of a different method or field, unless you are actually attempting to overload something else.
class SomeClass {
private String name;
private int age;
String getName() {
return this.name;
}
int getAge() {
return this.age;
}
public void doIt() {
// ...
}
}
class SomeChildClass extends SomeClass {
// An overload of the parent method.
public void doIt(int val1, int val2) {
// ...
}
// An override of the parent method.
@Override
public void doIt() {
// ...
}
}