For a boolean field, what is the naming convention for its getter/setter?

java

best-practices

code-comprehensibility

getter-setter

byAlex Kataev·Nov 27, 2024

Aim for the 'is' prefix in a Java boolean getter:

private boolean active;
public boolean isActive() {  // Appropriately prefixed 'is' as per convention!
    return active;
}
// Abide by the standards for a setter too
public void setActive(boolean active) { // No monkeying about!
    this.active = active;
}

When is looks out of place, opt for informative prefixes like has, can, or should:

private boolean hasAccount;   // Be clear about the property
public boolean hasAccount() { // Make it auto-explanatory
    return hasAccount;
}
public void setHasAccount(boolean hasAccount) { // As clear as drinking water
    this.hasAccount = hasAccount;
}

Clear communication rules over the convention.

Breakdown by Context: Does the Prefix 'Fit' Right?

When to use 'is', 'has', 'can', and 'should'

The nature of your boolean fields determines the type of prefix (usually, is, has, can, or should). Wondering how? Have a look at these:

Existence or Possession: If you have a hasLicense field, the possession is clear as daylight: public boolean hasLicense().
Capability: The canDoTask field means an ability—it's public boolean canDoTask().
Advisability: A shouldContinue field denotes advisability—use public boolean shouldContinue().

Aligning a meaningful prefix with the context of your boolean field amps up code comprehensibility and readability.

Better Field Naming: A Recipe for Better Method Names

Naming a boolean field starting with is, such as isAvailable, leads to getter names like isIsAvailable(). Pleasing to the eyes or mind? Nope!

// More like a stutter than slick coding
private boolean isAvailable;
public boolean isIsAvailable() { // My head doesn't like it, so should yours
    return isAvailable;
}

A tip: Name the field available and the getter isAvailable().

The Landmines in Code: Common Pitfalls and Decoding Them

Vague names: The conjuring spirits in coding

Avoid those enigmatic field names like status or flag. They barely offer any information and make your code as clear as mud. Instead of isStatus, something like isOrderConfirmed talks!

The Tale of Wrapper Classes vs Primitives

While dealing with Boolean wrapper objects and primitive boolean, remember this tip:

private Boolean isActive; // Wrapper class in action
public Boolean getActive() { // Use get for Boolean wrapper class
    return isActive;
}

private boolean active; // Classic primitive type
public boolean isActive() { // Use 'is' for primitive type
    return active;
}