6.5. Mutator Methods¶

Corresponding to each get method, programmers also provide a public set method to change the value of a private instance variable in a class. These are called mutator methods (or settters or set or modifier methods). They are void methods meaning that they do not return a value, but they do take a parameter, the new value for the instance variable. Here are some examples of how to write a set method for an instance variable:

class ExampleTemplate {

    //Instance variable declaration
    private typeOfVar varName;

    // Mutator (setter) method template
    public void setVarName(typeOfVar newValue)
    {
       varName = newValue;
    }
}

Here’s an example of the Student class with a mutator method called setName():

class Student {

   //Instance variable name
   private String name;

   /** setName sets name to newName
    *  @param newName                */
   public void setName(String newName)
   {
      name = newName;
   }

   public static void main(String[] args)
   {
      // To call a set method, use objectName.setVar(newValue)
      Student s = new Student();
      s.setName("Ayanna");
   }
  }

Notice the difference between set (mutator) and get (accessor) methods in the following figure. Getters return an instance variable’s value and have the same return type as this variable and no parameters. Setters have a void return type and take a new value as a parameter to change the value of the instance variable.

../_images/get-set-comparison.png — Figure 1: Comparison of set and get methods¶

Coding Exercise

Try the Student class below which this time has set methods added. You will need to fix one error. The main method is in a separate Tester class and does not have access to the private instance variables in the other Student class. Change the main method so that it uses a public mutator method (set method) to access the value instead.

Fix the main method to include a call to the appropriate set method.

public class TesterClass
{
   // main method for testing
   public static void main(String[] args)
   {
      Student s1 = new Student("Skyler", "skyler@sky.com", 123456);
      System.out.println(s1);
      s1.setName("Skyler 2");
      // Main doesn't have access to email, use set method!
      s1.email = "skyler2@gmail.com";
      System.out.println(s1);
   }
 }

class Student
{
   private String name;
   private String email;
   private int id;

public Student(String initName, String initEmail, int initId)
   {
      name = initName;
      email = initEmail;
      id = initId;
   }
   // mutator methods - setters
   public void setName(String newName)
   {
     name = newName;
   }
   public void setEmail(String newEmail)
   {
     email = newEmail;
   }
   public void setId(int newId)
   {
     id = newId;
   }
   // accessor methods - getters
   public String getName()
   {
      return name;
   }
   public String getEmail()
   {
      return email;
   }
   public int getId()
   {
      return id;
   }
   public String toString() {
      return id + ": " + name + ", " + email;
   }
}

Check your understanding

6-5-2: Consider the class Party which keeps track of the number of people at the party.

public class Party
{
    //number of people at the party
    private int numOfPeople;

    /* Missing header of set method */
    {
        numOfPeople = people;
    }
}

Which of the following method signatures could replace the missing header for the set method in the code above so that the method will work as intended?

public int getNum(int people)
The set method should not have a return value and is usually named set, not get.
public int setNum()
The set method should not have a return value and needs a parameter.
public int setNum(int people)
The set method should not have a return value.
public void setNum(int people)
Yes, the set method should take a parameter called people and have a void return value. The name of the set method is usually set followed by the full instance variable name, but it does not have to be an exact match.
public int setNumOfPeople(int p)
The parameter of this set method should be called people in order to match the code in the method body.

6-5-3: Drag the definition from the left and drop it on the correct word on the right. Click the "Check Me" button to see if you are correct.

Review the vocabulary.

gets and returns the value of an instance variable
accessor method
sets the instance variable to a value in its parameter
mutator method
initializes the instance variables to values
constructor
accessible from outside the class
public
accessible only inside the class
private

Mutator methods do not have to have a name with “set” in it, although most do. They can be any methods that change the value of an instance variable or a static variable in the class.

6.5.1. Programming Challenge : Class Pet Setters¶

Copy your Awesome Animal Clinic Pet class from the last lesson into this Active Code window.
Add set methods for each of the 5 instance variables. Make sure you use good commenting!
Test each of the set methods in the main method.

Create a Pet class that keeps track of the name, age, weight, type of animal, and breed for records at an animal clinic with 2 constructors, accessor (get) methods, a toString method, and mutator (set) methods for each instance variable.

6.5.2. Practice¶

6-5-5: Consider the following class definition.

public class Liquid
{
    private int currentTemp;

    public Liquid(int temp)
    {
        currentTemp = temp;
    }

    public void resetTemp()
    {
        currentTemp = newTemp;
    }
}

Which of the following best identifies the reason the class does not compile?

The constructor header does not have a return type.
The constructor should not have a return type.
The resetTemp method is missing a return type.
Mutator methods usually have a void return type.
The constructor should not have a parameter.
Constructors can have parameters.
The resetTemp method should have a parameter.
Correct! The resetTemp method should have a parameter for the newTemp value to set the currentTemp.
The instance variable currentTemp should be public instead of private.
Instance variables should be private variables.

6-5-6: In the Party class below, the addPeople method is intended to increase the value of the instance variable numOfPeople by the value of the parameter additionalPeople. The method does not work as intended.

public class Party
{
    private int numOfPeople;

    public Party(int n)
    {
        numOfPeople = n;
    }

    public int addPeople(int additionalPeople) // Line 10
    {
        numOfPeople += additionalPeople; // Line 12
    }
}

Which of the following changes should be made so that the class definition compiles without error and the method addPeople works as intended?

Replace line 12 with numOfPeople = additionalPeople;
This method should add additionalPeople to numOfPeople.
Replace line 12 with return additionalPeople;
This method should add additionalPeople to numOfPeople.
Replace line 12 with additionalPeople += 3;
This method should add additionalPeople to numOfPeople.
Replace line 10 with public addPeople (int additionalPeople)
Mutator methods should have a void return type.
Replace line 10 with public void addPeople(int additionalPeople)
Mutator methods should have a void return type.

6.5.3. Summary¶

A void method does not return a value. Its header contains the keyword void before the method name.
A mutator method is often a void method that changes the values of instance variables or static variables.

You have attempted of activities on this page