Topic 5.4: Accessor Methods

In Java, classes serve as blueprints for creating objects. These classes can encapsulate attributes (fields) and behaviors (methods). One of the cornerstones of Object-Oriented Programming is data encapsulation. This principle restricts direct access to some of an object’s components, ensuring data integrity and security. Accessor methods, colloquially known as “getters”, offer a controlled means to access these attributes.

Accessor Methods

An Accessor Method permits other objects to retrieve the value of instance or static variables. They are typically non-void methods without parameters that return a value.

For instance, consider a class Circle:

public class Circle {
    private double radius;

    public Circle(double r) {
        this.radius = r;
    }

    // Accessor method for radius
    public double getRadius() {
        return radius;
    }
}

In the code above, the method getRadius is an accessor method. It allows external code to retrieve the value of the radius attribute without directly accessing the private field. This is a fundamental aspect of data encapsulation, ensuring that the internal state of an object is protected and can only be accessed or modified in controlled ways.

Return by Value

Java employs the “return by value” approach for its methods. This implies that when a method returns a value, it’s essentially returning a copy of that value. This is especially true for primitive data types.

public int getIntegerValue() {
    int value = 5;
    return value;
}

In the method above, the value 5 is returned, not the variable value itself.

Reference Return

For objects, when a method returns an object, it’s essentially returning a reference to that object, not a fresh copy. This becomes pivotal when dealing with mutable objects.

public class Box {
    private ArrayList<String> items;

    public Box() {
        items = new ArrayList<>();
    }

    public ArrayList<String> getItems() {
        return items;
    }
    public static void main(String[] args){
        Box box = new Box();
        ArrayList<String> boxItems = box.getItems();

        box.items.add("food");
        box.items.add("potatoes");
        box.items.add("Vardaan");
        System.out.println(box.items);
    }
}
Box.main(null);

[food, potatoes, Vardaan]

If you append an item to the ArrayList returned by getItems, will it modify the original items in the Box object?

Answer:

`toString` Method

The toString method offers a string representation of an object. By default, it returns the class name followed by its memory address. However, it’s a common practice to override this method to provide a more descriptive representation.

public class Circle {
    private double radius;

    public Circle(double r) {
        this.radius = r;
    }

    @Override //allows to rewrite this method
    public String toString() {
        return "Circle with radius: " + radius;
    }

    public static void main(String[] args) {
        Circle circle = new Circle(5.0);
        System.out.println(circle); // This will implicitly call the toString() method
    }
}

Circle.main(null);

Without overriding, what would the default toString method return?

Answer: REPL.$JShell$12C$Circle@644d5f66

Topic 5.5: Mutator Methods

Mutator methods, often referred to as “setters”, play a crucial role in object-oriented programming. They allow controlled modification of an object’s state. While accessor methods (“getters”) retrieve the state of an object, mutator methods modify it.

Void Methods

A void method does not return any value. Instead, its primary purpose is to perform an action. The keyword void in the method’s header signifies that the method won’t return any value.

public class exampleVoid {
    public void displayMessage() {
        System.out.println("Hello, World!");
    }

    public static void main(String[] args) {
        exampleVoid example = new exampleVoid();
        example.displayMessage();
    }
}

exampleVoid.main(null);

Hello, World!

In the example above, the displayMessage method doesn’t return any value; it simply prints a message to the console.

Mutator (Modifier) Methods

A mutator method is typically a void method that alters the values of instance or static variables. These methods ensure that the internal state of an object can be changed in a controlled manner, adhering to the principles of data encapsulation and data integrity.

Consider a class Rectangle:

public class Rectangle {
    private double length;
    private double width;

    // Mutator method for length
    public void setLength(double length) {
        if (length > 0) {
            this.length = length;
        } else {
            System.out.println("Invalid length provided.");
        }
    }

    // Mutator method for width
    public void setWidth(double width) {
        if (width > 0) {
            this.width = width;
        } else {
            System.out.println("Invalid width provided.");
        }
    }

    public static void main(String[] args) {
        Rectangle rect = new Rectangle();
        rect.setLength(5);
        rect.setWidth(-3);
    }
}

Rectangle.main(null);

Invalid width provided.

In the Rectangle class, the methods setLength and setWidth are mutator methods. They allow the modification of the length and width attributes, respectively, while ensuring that only valid values are set.

Suppose you add another method to the Rectangle class called setDimensions which takes a single string parameter in the format “length,width” (e.g., “10,5”). This method should parse the string, validate the values, and then set the length and width accordingly. If the string is in an invalid format or contains negative values, it should print an error message. Can you draft this method?

public class Rectangle {
    private double length;
    private double width;

    public void setLength(double length) {
        if (length > 0) {
            this.length = length;
        } else {
            System.out.println("Invalid length provided.");
        }
    }

    public void setWidth(double width) {
        if (width > 0) {
            this.width = width;
        } else {
            System.out.println("Invalid width provided.");
        }
    }

    public void setDimensions(String dimensions) {
        String[] parts = dimensions.split(",");
        
        if (parts.length != 2) {
            System.out.println("Invalid format. Please use 'length,width'.");
            return;
        }
        
        try {
            double newLength = Double.parseDouble(parts[0]);
            double newWidth = Double.parseDouble(parts[1]);
            
            if (newLength > 0 && newWidth > 0) {
                this.length = newLength;
                this.width = newWidth;
            } else {
                System.out.println("Invalid dimensions provided.");
            }
        } catch (NumberFormatException e) {
            System.out.println("Invalid numeric values in the dimensions.");
        }
    }

    public static void main(String[] args) {
        Rectangle rect = new Rectangle();
        
        rect.setDimensions("10,5");
        System.out.println("Length: " + rect.length + ", Width: " + rect.width);

        rect.setDimensions("5,3");
        System.out.println("Length: " + rect.length + ", Width: " + rect.width);

        rect.setDimensions("abc,def");
        rect.setDimensions("15");
        rect.setDimensions("10,-5");
    }
}
Rectangle.main(null)

Length: 10.0, Width: 5.0
Length: 5.0, Width: 3.0
Invalid numeric values in the dimensions.
Invalid format. Please use 'length,width'.
Invalid dimensions provided.

Topic 5.6: Writing Methods

Methods in Java allow us to define behaviors for objects. When these methods are non-void and have parameters, they can return a value based on the provided arguments.

Accessing Private Data

Methods can only access the private data and methods of a parameter that is a reference to an object when the parameter is of the same type as the method’s enclosing class. This ensures data encapsulation and integrity.

public class MyClass {
    private int privateData = 10;

    public int getPrivateData() {
        return privateData;
    }

    public static void main (String[] args) {
        MyClass example = new MyClass();
        int integer = example.getPrivateData();
        System.out.println(integer);
    }
}

MyClass.main(null);

Non-Void Methods with Parameters

These methods are designed to receive values, process them, and return a computed result.

public class AreaCalculator {
    public double calculateArea(double length, double width) {
        return length * width;
    }

    public static void main(String[] args) {
        AreaCalculator calculator = new AreaCalculator();
        double area = calculator.calculateArea(5, 10);
        System.out.println("Area: " + area);
    }
}

AreaCalculator.main(null);

Area: 50.0

Handling Mutable Objects

It’s a good programming practice not to modify mutable objects passed as parameters unless it’s explicitly required.

Why? Modifying mutable objects that are passed as parameters can lead to unintended side effects in the calling code. The calling code might not expect the object to be modified, and this can introduce bugs that are hard to trace. By avoiding the modification of passed objects, you ensure that the function or method is “pure” and doesn’t produce unexpected side effects.

import java.util.ArrayList;

public class ListModifier {
    public void modifyList(ArrayList<String> list) {
        // Not recommended unless explicitly required
        list.add("New Item");
    }

    public static void main(String[] args) {
        ArrayList<String> items = new ArrayList<>();
        items.add("Original Item");
        
        ListModifier modifier = new ListModifier();
        modifier.modifyList(items);
        
        System.out.println(items);
    }
}

Question: What will be the output of the above code?

Answer: [Original Item, New Item]

Primitive vs. Reference Parameters

When a method’s parameter is a primitive type, changes to it inside the method won’t affect the original value. However, for reference types, changes inside the method will reflect on the original object.

import java.util.ArrayList;

public class ValueModifier {
    public void modifyValues(int num, ArrayList<String> list) {
        num = 20;
        list.add("Modified");
    }

    public static void main(String[] args) {
        int number = 10;
        ArrayList<String> items = new ArrayList<>();
        
        ValueModifier modifier = new ValueModifier();
        modifier.modifyValues(number, items);
        
        System.out.println("Number: " + number);
        System.out.println("List: " + items);
    }
}

ValueModifier.main(null);

Number: 10
List: [Modified]

When a reference is passed to a method, both the original and the parameter inside the method point to the same memory location. This is termed as aliasing.

public class AliasingExample {
    public void addToList(ArrayList<String> list) {
        list.add("Aliased Item");
    }

    public static void main(String[] args) {
        ArrayList<String> items = new ArrayList<>();
        
        AliasingExample example = new AliasingExample();
        example.addToList(items);
        
        System.out.println(items);
    }
}

Given the AliasingExample class, add a method named removeFromList that removes an item from the list based on its index. After adding the item “Aliased Item” using the addToList method, use the removeFromList method to remove it.

Note: Due to aliasing, changes made to the list inside the method will reflect on the original list.

Topic 5.7: Static Variables and Methods

In Java, the static keyword plays a pivotal role in the realm of Object-Oriented Programming. It allows variables and methods to be associated with the class itself rather than instances of the class. Let’s delve deeper into the world of static components.

Static Variables

Static variables, unlike instance variables, are associated with the class itself and not with any specific instance. This means there’s only one copy of a static variable, which is shared among all instances of the class.

Key Points:

Single Copy: All instances of the class share the same copy of the static variable. This means if one object modifies a static variable, it reflects in all other instances.
Access Modifiers: Static variables can be either public or private, determining their visibility.
Usage: They are accessed using the class name, not through an instance.

public class Student {
    private static int studentCount = 0;
    private String name;

    public Student(String name) {
        this.name = name;
        studentCount++;
    }

    public static int getStudentCount() {
        return studentCount;
    }

    public static void main(String[] args) {
        Student alice = new Student("Alice");
        Student bob = new Student("Bob");
        System.out.println("Total Students: " + Student.getStudentCount());
    }
}

Question: If another student, Vardaan, enrolls, what will be the output of Student.getStudentCount()?

Answer: Total Students: 2

Static Methods

Static methods are methods that belong to the class, not any specific instance. This means you can call a static method without creating an object of the class.

Key Points:

Association with Class: Static methods are not tied to an instance of the class. This means they can’t access instance variables or methods directly.
Access Restrictions: Static methods cannot access instance variables or call non-static methods directly. They can only access static variables or call other static methods.
Usage: They are called using the class name.

public class MathUtility {
    public int num;
    
    public static int square(int number) {
        return number * number;
    }

    public static void main(String[] args) {
        int result = MathUtility.square(num);
        System.out.println("Square: " + result);
    }
}

|           int result = MathUtility.square(num);

non-static variable num cannot be referenced from a static context

Question: What is the problem with the above code (do not run the cell)?

Answer: a non-static variable (num) cannot be referenced from a static context; the variable num is referenced in the static void: main.

Aliasing in Static Components

Given that static variables are shared among all instances, changes in one instance reflect in others. This is a form of aliasing, where multiple references point to the same memory location.

public class SharedResource {
    // Static variable shared among all instances
    public static int sharedCount = 0;

    public void incrementCount() {
        sharedCount++;
    }

    public static void main(String[] args) {
        SharedResource obj1 = new SharedResource();
        SharedResource obj2 = new SharedResource();

        obj1.incrementCount();
        System.out.println("Shared count after incrementing in obj1: " + SharedResource.sharedCount);

        obj2.incrementCount();
        System.out.println("Shared count after incrementing in obj2: " + SharedResource.sharedCount);
    }
}

SharedResource.main(null);

Shared count after incrementing in obj1: 1
Shared count after incrementing in obj2: 2

When you run the above code, you’ll notice that the sharedCount variable is incremented by both obj1 and obj2, demonstrating that the static variable is indeed shared among all instances.

Topic 5.8: Scope and Access

In Java, the scope of a variable determines where it can be accessed or modified. The scope is defined by where the variable is declared. Let’s delve into the intricacies of variable scope and access in Java.

Local

Local variables are declared within methods or constructors. Their scope is limited to the block in which they are declared, which means they can’t be accessed outside of that block.

Key Points:

Declaration: Local variables can be declared in methods or constructors.
Accessibility: They can only be used within the method or constructor where they are declared.
Modifiers: Local variables cannot have access modifiers like public or private.

public class LocalVariableExample {
    public void displayMessage() {
        String localVariable = "Hello, World!";
        System.out.println(localVariable);
    }

    public static void main(String[] args) {
        LocalVariableExample example = new LocalVariableExample();
        example.displayMessage();
    }
}

LocalVariableExample.main(null);

In the above code, localVariable is a local variable that can only be accessed within the displayMessage method.

Shadowing

When a local variable has the same name as an instance variable, the local variable shadows or hides the instance variable. In such cases, the local variable takes precedence.

public class ShadowExample {
    private int value = 10;

    public void printValue(int value) {
        System.out.println(value);  // Refers to the local variable
        System.out.println(this.value);  // Refers to the instance variable
    }

    public static void main(String[] args) {
        ShadowExample example = new ShadowExample();
        example.printValue(5);
    }
}

ShadowExample.main(null);

5
10

Question: In the ShadowExample class, if we didn’t use the this keyword, which value would the method refer to?

Answer: the method would refer to the private int value

Formal Parameters

Formal parameters in methods or constructors are treated as local variables. Their scope is limited to the method or constructor in which they are defined.

public class DetailsDisplay {
    public void displayDetails(String name, int age) {
        System.out.println("Name: " + name);
        System.out.println("Age: " + age);
    }

    public static void main(String[] args) {
        DetailsDisplay display = new DetailsDisplay();
        display.displayDetails("John", 25);
    }
}

DetailsDisplay.main(null);

Name: John
Age: 25

In the above method, name and age are formal parameters and can only be accessed within the displayDetails method.

Method Decomposition

Method decomposition is a programming technique where a complex problem is broken down into smaller, more manageable subproblems. Each subproblem is solved using a separate method. This approach promotes modularity and reusability.

For instance, consider the following example for calculating the area and perimeter of a rectangle:

public class RectangleOperations {
    public double calculateArea(double length, double width) {
        return length * width;
    }

    public double calculatePerimeter(double length, double width) {
        return 2 * (length + width);
    }

    public static void main(String[] args) {
        RectangleOperations operations = new RectangleOperations();
        System.out.println("Area: " + operations.calculateArea(5, 10));
        System.out.println("Perimeter: " + operations.calculatePerimeter(5, 10));
    }
}

RectangleOperations.main(null);

Area: 50.0
Perimeter: 30.0

import java.util.*;

class BankAccount { //Stores the key information per bank account
    private int accountNumber;
    private double balance;

    public BankAccount() {
        this.accountNumber = generateAccountNumber();
        this.balance = 0.0;
    }

    public int getAccountNumber() {//Tells us account number
        return accountNumber;
    }

    public double getBalance() {//Tells us account balance
        return balance;
    }

    public void deposit(double amount) {//Deposits certain amount of money
        if (amount > 0) {
            balance += amount;
            System.out.println("Deposited $" + amount + " to account " + accountNumber);
        }
    }

    public void withdraw(double amount) { //Withdraws certain amount of money
        if (amount > 0 && balance >= amount) {
            balance -= amount;
            System.out.println("Withdrawn $" + amount + " from account " + accountNumber);
        } else {
            System.out.println("Insufficient funds for withdrawal from account " + accountNumber);
        }
    }

    private int generateAccountNumber() {
        return new Random().nextInt(10000);
    }
}

class Bank { //Describes the certain bank
    private ArrayList<BankAccount> accounts;
    private double totalBankDeposits;

    public Bank() {
        accounts = new ArrayList<>(); //Stores the amount of accounts in this bank
        totalBankDeposits = 0.0; //How many deposits made in total
    }

    public void createAccount() { //Makes a new account and adds that account to the accounts list
        BankAccount account = new BankAccount();
        accounts.add(account);
        System.out.println("New account created with account number: " + account.getAccountNumber());
    }

    public void processTransaction(int accountNumber, double amount) { //Does all of the transaction procession
        BankAccount account = findAccount(accountNumber);
        if (account != null) {
            account.deposit(amount);
            totalBankDeposits += amount;
        } else {
            System.out.println("Account not found for transaction.");
        }
    }

    public double getTotalBankDeposits() {
        return totalBankDeposits;
    }

    private BankAccount findAccount(int accountNumber) { //Helps find a certain bank account
        for (BankAccount account : accounts) {
            if (account.getAccountNumber() == accountNumber) {
                return account;
            }
        }
        return null;
    }
}

public class BankingApplication {//Sets up a banking simulation
    public static void main(String[] args) {
        Bank bank = new Bank();

        bank.createAccount();
        bank.createAccount();

        bank.processTransaction(1, 1000.0);
        bank.processTransaction(2, 500.0);

        System.out.println("Total bank deposits: $" + bank.getTotalBankDeposits()); //Tells us total Bank Accounts made overal
    }
}

CompSci Blogs

August 2023 to June 2024

Topics 5.4-5.8 • 46 min read

Topic 5.4: Accessor Methods

Accessor Methods

Return by Value

Reference Return

`toString` Method

Topic 5.5: Mutator Methods

Void Methods

Mutator (Modifier) Methods

Topic 5.6: Writing Methods

Accessing Private Data

Non-Void Methods with Parameters

Handling Mutable Objects

Primitive vs. Reference Parameters

Topic 5.7: Static Variables and Methods

Static Variables

Key Points:

Static Methods

Key Points:

Aliasing in Static Components

Topic 5.8: Scope and Access

Local

Shadowing

Formal Parameters

Method Decomposition

Topic 5.4: Accessor Methods

Accessor Methods

Return by Value

Reference Return

toString Method

Topic 5.5: Mutator Methods

Void Methods

Mutator (Modifier) Methods

Topic 5.6: Writing Methods

Accessing Private Data

Non-Void Methods with Parameters

Handling Mutable Objects

Primitive vs. Reference Parameters

Topic 5.7: Static Variables and Methods

Static Variables

Key Points:

Static Methods

Key Points:

Aliasing in Static Components

Topic 5.8: Scope and Access

Local

Shadowing

Formal Parameters

Method Decomposition

`toString` Method